Add API documentation and endpoints.md

skeleton/docs/api.md

@@ -0,0 +1,26 @@
+# ${{ value.name }} API
+
+Here you can find the documentation for the ${{ value.name }} API.
+
+## Description
+
+${{ value.description }}
+
+### What you can do with the ${{ value.name }} API
+
+- **Create** a new ${{ value.name }}
+- **Read** an existing ${{ value.name }}
+- **Update** an existing ${{ value.name }}
+- **Delete** an existing ${{ value.name }}
+- **List** all ${{ value.name }}s
+- **Search** for ${{ value.name }}s
+- **Filter** ${{ value.name }}s
+- **Sort** ${{ value.name }}s
+- **Paginate** ${{ value.name }}s
+- **Export** ${{ value.name }}s
+- **Import** ${{ value.name }}s from a file
+- **Validate** ${{ value.name }} data
+
+
+
+

skeleton/docs/endpoints.md

@@ -0,0 +1,38 @@
+# Endpoints
+
+## Table of Contents
+
+- [Endpoints](#endpoints)
+  - [Table of Contents](#table-of-contents)
+  - [Authentication](#authentication)
+    - [POST /auth/register](#post-authregister)
+      - [Request](#request)
+      - [Response](#response)
+
+## Authentication
+
+### POST /auth/register
+
+Register a new user.
+
+#### Request
+
+```json
+{
+  "username": "john_doe",
+  "email": "
+    "password": "password"
+}
+```
+
+#### Response
+
+```json
+{
+  "id": 1,
+  "username": "john_doe",
+  "email": ""
+}
+```
+
+[]

skeleton/docs/index.md

@@ -0,0 +1,80 @@
+# ${{ values.name }}
+
+This is a basic example of a Markdown file for GitHub.
+
+## Description
+
+${{ values.description }}
+
+### Sub-subtitle
+
+Here are some formatting elements you can use:
+
+- **Bold**
+- *Italic*
+- `Code`
+
+You can create lists:
+
+1. First item
+2. Second item
+3. Third item
+
+And links:
+
+[This is a link to Google](https://www.google.com)
+
+You can create tables:
+
+| Header 1 | Header 2 |
+| -------- | -------- |
+| Cell 1   | Cell 2   |
+
+And you can mention people:
+
+@username
+
+You can also include code blocks with syntax highlighting:
+
+```python
+def hello_world():
+    print("Hello, world!")
+```
+
+And images:
+
+![This is an image](https://via.placeholder.com/150)
+
+And emojis:
+
+:smile: :+1: :rocket:
+
+### Different types of notes
+
+[!NOTE]
+This is a note.
+
+[!TIP]
+This is a tip.
+
+[!WARNING]
+This is a warning.
+
+[!IMPORTANT]
+This is important.
+
+[!CAUTION]
+This is a caution.
+
+### Task lists
+
+- [x] This is a complete item
+- [ ] This is an incomplete item
+- [ ] This is an incomplete item
+
+
+### Footnotes
+
+A footnote is a note placed at the bottom of a page in a document that provides additional information about a particular part of the text. You can create footnotes like this[^1].
+
+[^1]: This is the footnote.

skeleton/mkdocs.yml

@@ -0,0 +1,11 @@
+site_name: ${{values.name | dump}}
+site_description: ${{values.description | dump}}
+
+nav:
+  - Introduction: index.md
+  - API Reference:
+    - Overview: api.md
+    - Endpoints: endpoints.md
+
+plugins:
+  - techdocs-core