https://github.com/tobychui/gitdoca

A Simple Github docs/ rendering script using Markdown
https://github.com/tobychui/gitdoca

Last synced: 3 months ago
JSON representation

A Simple Github docs/ rendering script using Markdown

• Host: GitHub
• URL: https://github.com/tobychui/gitdoca
• Owner: tobychui
• License: mit
• Created: 2019-08-31T03:34:21.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-02-01T10:45:29.000Z (over 4 years ago)
• Last Synced: 2025-01-18T02:25:51.652Z (5 months ago)
• Size: 456 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![banner](docs/img/banner.png)

# GitDocA

 

A Simple Github docs/ rendering script using Markdown

## Demo

https://tobychui.github.io/GitDocA/

## Installation

Download the whole repo as zip and change out the documentations in the docs/lang/* folders.

## Documentation Format

The documents are basically markdown with the first line a JSON array stating the meta-data of the current document. In most case, it is an array containing only the document title. For example:

```

["Hello World!"]

# This is the markdown title

More content goes here and more lines

can be added afterward.

```