https://github.com/cosmomyzrailgorynych/comigodocs

A static documentation site generator without bullshit
https://github.com/cosmomyzrailgorynych/comigodocs

Last synced: about 8 hours ago
JSON representation

A static documentation site generator without bullshit

• Host: GitHub
• URL: https://github.com/cosmomyzrailgorynych/comigodocs
• Owner: CosmoMyzrailGorynych
• Created: 2020-02-05T05:42:25.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-05T06:54:11.000Z (almost 2 years ago)
• Last Synced: 2023-08-13T02:31:09.852Z (over 1 year ago)
• Language: JavaScript
• Size: 676 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        


    
ComigoDocs

    

    




ComigoDocs is an open-source documentation/static site generator. It aims to require 0 configs, and reduce the bullshit required to get a working, fully functional site with minimal maintenance in sense of updating its content.

Docs are generated from a folder of `.md` file (Markdown documents). Each `.md` file becomes a page, and folders with other files and folders will have one as well, with a nice listing of child pages. If you put an `index.md` file inside a folder, its content will be shown on the top of the folder's children listing. This all allows you to freely define structure: it may be flat, it can be one book with chapters split into parts, it can be a stack of such books, or any mixed variant. The only restriction is your imagination, and your imagination is the maximum call stack for a recursive function in js. (500 levels, I guess?)

## This all is a WIP, though

But to test it, clone the repo, and run:

```sh

npm install

npm link

comigodocs serve

```

## TODO

* a full-site search based on headings;

* a downloadable PDF version;

* easy copy for code blocks;

* automagic dark theme + the ability to pass a custom theme in query parameters (that's what I need for ct.js);

* configs to control layout for different pages; rn you can only set a `title` in the front matter of an `.md` file.