https://github.com/telkomdev/documentation-template

Template for documentation website
https://github.com/telkomdev/documentation-template

documentation mkdocs template

Last synced: 8 days ago
JSON representation

Template for documentation website

• Host: GitHub
• URL: https://github.com/telkomdev/documentation-template
• Owner: telkomdev
• License: mit
• Created: 2021-07-26T06:21:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-15T04:27:50.000Z (over 3 years ago)
• Last Synced: 2024-11-16T04:41:53.217Z (2 months ago)
• Topics: documentation, mkdocs, template
• Homepage: https://telkomdev.github.io/documentation-template/
• Size: 667 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Documentation Template

This repository works as template for developing documentation for our open source project.

## How to use

- click button `use this template`

- create new repository based on this repository, check include all branches

- Install python and pip

- Install `mkdocs-material` using pip by running this command:

  ```

  pip install mkdocs-material

  ```

- Run this line to preview demo

  ```

  python -m mkdocs serve

  ```

You then can start documenting your project using markdown format, without any knowledge of HTML, Javascript, or CSS.

## Demo

You can see the demo [here](https://telkomdev.github.io/documentation-template)

## Configuration

More configuration can see [here](https://squidfunk.github.io/mkdocs-material/)