mirror of
https://github.com/litruv/Docs-Viewer.git
synced 2026-07-24 02:36:07 +10:00
89 lines
2.1 KiB
Markdown
89 lines
2.1 KiB
Markdown
# Documentation Viewer
|
|
|
|
A lightweight, static documentation viewer that renders Markdown files with syntax highlighting. Built as a single-page application with no backend requirements.
|
|
|
|
## Features
|
|
|
|
- 📝 Renders Markdown documents with syntax highlighting
|
|
- 📑 Document outline/table of contents
|
|
- 📱 Responsive design with mobile support
|
|
- 🚀 Zero backend requirements - deploy anywhere
|
|
- ⚡ Fast client-side rendering
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js and npm (only needed for development)
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository:
|
|
|
|
```sh
|
|
git clone <repository-url>
|
|
cd <repository-directory>
|
|
```
|
|
|
|
2. Install dependencies (only needed for development):
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
### Deployment
|
|
|
|
This is a static website that can be hosted on any web server or static hosting service. Simply upload all files to your hosting provider.
|
|
|
|
For local testing, you can use any static file server. For example:
|
|
```sh
|
|
npx live-server
|
|
```
|
|
|
|
### Usage
|
|
|
|
- The file index is displayed on the left sidebar.
|
|
- Click on a file to load its content.
|
|
- The document outline is displayed on the right sidebar.
|
|
- Use the menu button to toggle the sidebar on mobile devices.
|
|
|
|
### Directory Structure
|
|
|
|
```
|
|
docs/ # Your markdown documents go here
|
|
├── images/ # Images referenced in documents
|
|
├── doc1.md
|
|
└── doc2.md
|
|
index.html # Main entry point
|
|
config.json # Document index configuration
|
|
styles.css # Custom styling
|
|
```
|
|
|
|
### Adding New Documents
|
|
|
|
1. Add your Markdown file to the `docs` directory.
|
|
2. Update to include the new document:
|
|
|
|
```json
|
|
{
|
|
"documents": [
|
|
{
|
|
"title": "Blueprint Depth Trace",
|
|
"path": "docs/Blueprint Penetration Trace.md"
|
|
},
|
|
{
|
|
"title": "New Document Title",
|
|
"path": "docs/NewDocument.md"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Acknowledgements
|
|
|
|
- [marked](https://github.com/markedjs/marked) for Markdown parsing.
|
|
- [Prism](https://prismjs.com/) for syntax highlighting.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. |