Skip to content

Commit cf2c740

Browse files
FredyRivera-devFredyRivera-dev
committed
Add Docs
1 parent 4bf85b2 commit cf2c740

File tree

5 files changed

+468
-8
lines changed

5 files changed

+468
-8
lines changed

‎css/search.css‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
/* search.css - Styles for search functionality */
2+
3+
/* Search modal */
4+
.search-modal {
5+
position: fixed;
6+
top: 0;
7+
left: 0;
8+
width: 100%;
9+
height: 100%;
10+
background-color: rgba(0, 0, 0, 0.7);
11+
backdrop-filter: blur(5px);
12+
z-index: 1000;
13+
display: flex;
14+
justify-content: center;
15+
align-items: flex-start;
16+
padding-top: 5rem;
17+
}
18+
19+
.search-modal-content {
20+
background-color: var(--card-bg);
21+
width: 90%;
22+
max-width: 700px;
23+
border-radius: 8px;
24+
box-shadow: 0 10px 25px rgba(0, 0, 0, 0.5);
25+
overflow: hidden;
26+
max-height: 80vh;
27+
display: flex;
28+
flex-direction: column;
29+
}
30+
31+
/* Search header */
32+
.search-header {
33+
display: flex;
34+
border-bottom: 1px solid var(--border-color);
35+
padding: 1rem;
36+
}
37+
38+
.search-modal-input {
39+
flex: 1;
40+
background-color: transparent;
41+
border: none;
42+
color: var(--text-primary);
43+
font-size: 1.1rem;
44+
outline: none;
45+
}
46+
47+
.search-close-btn {
48+
background: none;
49+
border: none;
50+
color: var(--text-secondary);
51+
font-size: 1.5rem;
52+
cursor: pointer;
53+
width: 30px;
54+
height: 30px;
55+
display: flex;
56+
align-items: center;
57+
justify-content: center;
58+
border-radius: 50%;
59+
}
60+
61+
.search-close-btn:hover {
62+
background-color: var(--hover-bg);
63+
color: var(--text-primary);
64+
}
65+
66+
/* Search results */
67+
.search-results {
68+
overflow-y: auto;
69+
max-height: calc(80vh - 60px);
70+
padding: 0;
71+
}
72+
73+
.search-empty {
74+
padding: 2rem;
75+
text-align: center;
76+
color: var(--text-secondary);
77+
}
78+
79+
.search-result-item {
80+
padding: 1rem;
81+
border-bottom: 1px solid var(--border-color);
82+
cursor: pointer;
83+
transition: background-color 0.2s;
84+
}
85+
86+
.search-result-item:hover {
87+
background-color: var(--hover-bg);
88+
}
89+
90+
.search-result-title {
91+
font-weight: bold;
92+
margin-bottom: 0.5rem;
93+
}
94+
95+
.search-result-context {
96+
font-size: 0.9rem;
97+
color: var(--text-secondary);
98+
line-height: 1.4;
99+
}
100+
101+
.search-highlight {
102+
background-color: rgba(138, 43, 226, 0.3);
103+
color: var(--primary-light);
104+
padding: 0 2px;
105+
border-radius: 2px;
106+
}
107+
108+
/* Keyboard shortcut badge in results */
109+
.search-shortcut {
110+
display: inline-block;
111+
padding: 2px 6px;
112+
background-color: var(--card-bg);
113+
border: 1px solid var(--border-color);
114+
border-radius: 4px;
115+
font-size: 0.75rem;
116+
color: var(--text-secondary);
117+
margin-left: 0.5rem;
118+
}

‎docs/api.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# API Reference
2+
3+
AtlasServer provides a comprehensive API to programmatically manage your applications.
4+
5+
## Authentication
6+
7+
All API endpoints use session-based authentication. You need to be logged into the AtlasServer dashboard in your browser to use the API.

‎docs/frameworks.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Supported Frameworks Guide
2+
3+
AtlasServer Core currently supports Python web frameworks for quick deployments and demos. This guide explains how to configure and deploy applications built with these frameworks.
4+
5+
## Currently Supported Frameworks
6+
7+
### Flask
8+
9+
Flask is a lightweight WSGI web application framework. AtlasServer uses Waitress to serve Flask applications.
10+
11+
#### Requirements
12+
13+
- A Flask application with an `app` instance
14+
- Waitress (included in AtlasServer dependencies)
15+
16+
#### Configuration
17+
18+
When registering a Flask application in AtlasServer:
19+
20+
1. Set the **Application Type** to "flask"
21+
2. Specify the **Main File** containing your Flask app (e.g., `app.py`)
22+
3. Make sure your app is named `app` in the main file:
23+
```python
24+
from flask import Flask
25+
app = Flask(__name__) # Must be named 'app'
26+
```
27+
28+
#### Example
29+
30+
```python
31+
# app.py
32+
from flask import Flask
33+
34+
app = Flask(__name__)
35+
36+
@app.route('/')
37+
def hello():
38+
return "Hello from Flask!"
39+
40+
if __name__ == '__main__':
41+
app.run(debug=True)
42+
```
43+
44+
### FastAPI
45+
46+
FastAPI is a modern, fast web framework for building APIs. AtlasServer uses Uvicorn to serve FastAPI applications.
47+
48+
#### Requirements
49+
50+
- A FastAPI application with an `app` instance
51+
- Uvicorn (included in AtlasServer dependencies)
52+
53+
#### Configuration
54+
55+
When registering a FastAPI application in AtlasServer:
56+
57+
1. Set the **Application Type** to "fastapi"
58+
2. Specify the **Main File** containing your FastAPI app (e.g., `main.py`)
59+
3. Make sure your app is named `app` in the main file:
60+
```python
61+
from fastapi import FastAPI
62+
app = FastAPI() # Must be named 'app'
63+
```
64+
65+
#### Example
66+
67+
```python
68+
# main.py
69+
from fastapi import FastAPI
70+
71+
app = FastAPI()
72+
73+
@app.get("/")
74+
async def root():
75+
return {"message": "Hello from FastAPI!"}
76+
77+
if __name__ == "__main__":
78+
uvicorn.run()
79+
```
80+
81+
## Coming Soon to AtlasServer Core
82+
83+
We're working on adding support for more Python frameworks:
84+
85+
- **Django**: For full-featured web applications
86+
87+
## Premium Features (Coming in Paid Version)
88+
89+
AtlasServer's paid version will include support for JavaScript/TypeScript frameworks:
90+
91+
- **Next.js**: Server-side rendering and static site generation for React
92+
- **Express.js**: Minimal and flexible Node.js web application framework
93+
- **Vite**: Modern frontend build tool and dev server
94+
- **And more**: Support for other popular JS/TS frameworks

‎index.html‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
<!DOCTYPE html>
2-
<html lang="es">
2+
<html lang="en">
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>AtlasServer - Documentación</title>
6+
<title>AtlasServer - Documentation</title>
77
<link rel="stylesheet" href="css/styles.css">
8-
<!-- Librería para convertir Markdown a HTML -->
8+
<link rel="stylesheet" href="css/search.css">
9+
<!-- Library for converting Markdown to HTML -->
910
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
10-
<!-- Opcional: para resaltado de código -->
11+
<!-- Optional: for code highlighting -->
1112
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css">
1213
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js"></script>
1314
</head>
@@ -23,7 +24,6 @@ <h1>AtlasServer</h1>
2324
</div>
2425
<div class="header-actions">
2526
<a href="#" class="support-link">Support</a>
26-
<a href="#" class="dashboard-btn">Dashboard</a>
2727
</div>
2828
</header>
2929

@@ -33,27 +33,34 @@ <h1>AtlasServer</h1>
3333
<div class="nav-header">Guides</div>
3434
<a href="#" class="nav-link active" data-doc="index">Introduction</a>
3535
<a href="#" class="nav-link" data-doc="installation">Installation</a>
36+
<a href="#" class="nav-link" data-doc="frameworks">Frameworks</a>
3637
</div>
3738

3839
<div class="nav-section">
3940
<div class="nav-header">API Reference</div>
4041
<a href="#" class="nav-link" data-doc="api">API</a>
4142
</div>
43+
44+
<div class="nav-section">
45+
<div class="nav-header">Community</div>
46+
<a href="https://github.com/AtlasServer-Core" target="_blank" class="nav-link">GitHub</a>
47+
</div>
4248
</nav>
4349

4450
<main id="content" class="content">
45-
<!-- El contenido Markdown se cargará aquí -->
46-
<div class="loading">Cargando documentación...</div>
51+
<!-- Markdown content will be loaded here -->
52+
<div class="loading">Loading documentation...</div>
4753
</main>
4854

4955
<aside class="page-nav">
5056
<div class="page-nav-header">On this page</div>
5157
<div id="page-nav-links">
52-
<!-- Links de navegación en página se generarán aquí -->
58+
<!-- Page navigation links will be generated here -->
5359
</div>
5460
</aside>
5561
</div>
5662

5763
<script src="js/docs.js"></script>
64+
<script src="js/search.js"></script>
5865
</body>
5966
</html>

0 commit comments

Comments
 (0)