bnkops/Changemaker
bnkops/Changemaker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

file clean up

Browse Source
This commit is contained in:
admin 2025-05-14 09:00:20 -06:00
parent 84057b6a9e
commit 7413d15125
2 changed files with 0 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
code-server-mkdocs.md
View File

@ -1,61 +0,0 @@
# MkDocs in Code-Server
This setup allows you to edit and manage your MkDocs site directly within the Code-Server web IDE.
## Available Commands
The MkDocs-Material package has been installed in a virtual environment with all required dependencies, including imaging support for the social plugin. You can use the following commands in the terminal inside code-server:
### Basic usage
```bash
# Run mkdocs commands directly
mkdocs --help
mkdocs build
mkdocs serve --dev-addr=0.0.0.0:8000
# Or use the convenience script that automatically changes to the mkdocs directory
run-mkdocs --help
run-mkdocs build
run-mkdocs serve --dev-addr=0.0.0.0:8000
```
### Installed MkDocs Extensions
The following MkDocs plugins and extensions are pre-installed:
- `mkdocs-material` (with imaging support)
- `mkdocs-minify-plugin`
- `mkdocs-git-revision-date-localized-plugin`
- `mkdocs-glightbox`
- `mkdocs-redirects`
### Installing Additional Plugins
To install additional MkDocs plugins or dependencies:
```bash
# Install additional MkDocs plugins
pip install <plugin-name>
# For example, to install another plugin
pip install mkdocs-awesome-pages-plugin
```
## Folder Structure
- `/home/coder/mkdocs` - Your MkDocs project directory (shared with the mkdocs container)
- `/home/coder/.venv/mkdocs/bin` - Contains the Python virtual environment with mkdocs
- `/home/coder/.local/bin` - Contains the run-mkdocs convenience script
## Tips
1. When running `mkdocs serve` inside code-server, use `--dev-addr=0.0.0.0:8000` to make it accessible.
2. The mkdocs container is still available and running in parallel if needed.
3. You can use the VS Code file explorer to easily navigate and edit your MkDocs files.
4. Use the `Code-OSS Markdown Preview` feature to preview your markdown files as you edit them.
## Tips
1. When running `mkdocs serve` inside code-server, use `--dev-addr=0.0.0.0:8000` to make it accessible.
2. The mkdocs container is still available and running in parallel if needed.
3. You can use the VS Code file explorer to easily navigate and edit your MkDocs files.

78
mkdocs-code-server.md
View File

@ -1,78 +0,0 @@
# MkDocs in Code-Server
This setup allows you to edit and manage your MkDocs site directly within the Code-Server web IDE.
## Available Commands
The MkDocs-Material package has been installed in a virtual environment with all recommended extras. You can use the following commands in the terminal inside code-server:
### Basic usage
```bash
# Run mkdocs commands directly
mkdocs --help
mkdocs build
mkdocs serve --dev-addr=0.0.0.0:8000
# Or use the convenience script that automatically changes to the mkdocs directory
run-mkdocs --help
run-mkdocs build
run-mkdocs serve --dev-addr=0.0.0.0:8000
```
### Advanced Features
The following MkDocs-Material features are available:
1. **Social Cards** - Automatically generate social cards for your pages
2. **PDF Export** - Create PDF versions of your documentation
3. **Mermaid Diagrams** - Create flowcharts and diagrams
4. **Blog Support** - Use the blog plugin for creating blog posts
5. **Git Integration** - Show last update date from git history
### Installing Additional Plugins
If you need to install additional plugins:
```bash
# Install additional MkDocs plugins
pip install <plugin-name>
# For example, to install a new plugin
pip install mkdocs-your-plugin-name
```
## Troubleshooting
If you encounter issues with dependencies, run the following script to check the installation:
```bash
bash /home/bunker-admin/Changemaker/mkdocs-check.sh
```
## Installed Plugins
The following plugins are pre-installed:
- mkdocs-material (with imaging, recommended, and git extras)
- mkdocs-minify-plugin
- mkdocs-git-revision-date-localized-plugin
- mkdocs-glightbox
- mkdocs-redirects
- mkdocs-awesome-pages-plugin
- mkdocs-blog-plugin
- mkdocs-rss-plugin
- mkdocs-meta-descriptions-plugin
- mkdocs-swagger-ui-tag
- mkdocs-macros-plugin
- mkdocs-material-extensions
- mkdocs-section-index
- mkdocs-table-reader-plugin
- mkdocs-pdf-export-plugin
- mkdocs-mermaid2-plugin
## Folder Structure
- `/home/coder/mkdocs` - Your MkDocs project directory (shared with the mkdocs container)
- `/home/coder/.venv/mkdocs/bin` - Contains the mkdocs executable and installed plugins
- `/home/coder/.local/bin` - Contains convenience scripts