https://github.com/buscedv/docual

A self-hosted static frontend for markdown files (ex. GitHub READMEs).
https://github.com/buscedv/docual

documentation documentation-generator documentation-tool free-software gplv3 open-source self-hosted static

Last synced: about 2 months ago
JSON representation

A self-hosted static frontend for markdown files (ex. GitHub READMEs).

• Host: GitHub
• URL: https://github.com/buscedv/docual
• Owner: Buscedv
• License: gpl-3.0
• Created: 2019-09-12T18:00:56.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T03:38:58.000Z (about 2 years ago)
• Last Synced: 2023-03-06T14:32:36.495Z (almost 2 years ago)
• Topics: documentation, documentation-generator, documentation-tool, free-software, gplv3, open-source, self-hosted, static
• Language: Vue
• Homepage: https://docual.edvard.dev
• Size: 7.32 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docual

## What is Docual?

A self hosted frontend for markdown files (ex. GitHub READMEs). Docual picks out your headings and sub-headings, and creates a sidebar for easy navigation. Docual also integrates a powerful search function. 

Docual is perfect for documentation and informative content. It takes 5 minutes to setup and updates whenever you update the source markdown file wich can be stored anyware (as long as Docual can access it).

## Examples

The programming language "Enkelt" keeps their documentation in a GitHub wiki and uses Docual as a frontend layer.

[Check it out here](https://dokumentation.enkelt.io)!

# Get Started

## 1

Clone this repo

Copy the "docual" folder and paste it somewhere else.

## 2

Configure the site from the config files found in the */public* folder (`config.json` and `colors.css`), or change the source of the site. Docual is powered by Vue.js.

## (2b)

You can test your site locally by first running `npm install` and then `npm run serve`, which will start a local server on (default) `http://localhost:8080`.

## 3

You can either host your page on a service like Netlify that offers automatic deploys for Vue.js apps, or you can host it anywere you can hot static webpages by running `npm run build` and then serving your site from the */dist* folder.

# Contact

- [GitHub](https://github.com/Docual)

- [Email](mailto:[email protected])

Edvard Busck-Nielsen, Docual 2020.