https://github.com/sourceplusplus/documentation

Public documentation for Source++
https://github.com/sourceplusplus/documentation

mkdocs

Last synced: about 1 month ago
JSON representation

Public documentation for Source++

• Host: GitHub
• URL: https://github.com/sourceplusplus/documentation
• Owner: sourceplusplus
• License: cc0-1.0
• Created: 2021-09-20T11:59:15.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-30T21:18:34.000Z (7 months ago)
• Last Synced: 2024-05-30T23:53:00.362Z (7 months ago)
• Topics: mkdocs
• Language: HTML
• Homepage: https://docs.sourceplus.plus
• Size: 28.6 MB
• Stars: 0
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/How-to-build.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Setup

## Requirements

- [MkDocs](https://www.mkdocs.org/#installation)

- pip

```shell

sudo apt update

sudo apt install python3-pip

sudo apt-get install mkdocs

pip3 install mkdocs-material

pip3 install mkdocs-awesome-pages-plugin

pip3 install fancyboxmd

pip3 install mkdocs-macros-plugin

pip3 install mkdocs-git-revision-date-localized-plugin

```

# Usage

## Serve Docs

```shell

mkdocs serve

```

Visit: http://127.0.0.1:8000/