docxy / docgen

Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.

Docxy

Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.

Prerequisites

• Git
• Node.js, preferrably the LTS version

Get started

1. Install the Docxy CLI

2. Create your Docxy project:

   docxy create my-awesome-docs

3. Initialize Docxy in the project directory:

   cd my-awesome-docs
   docxy init

4. Add markdown pages in the contents directory which will serve as your documentation pages. You'll find two example pages already in there.

5. Edit the config.yaml file in the contents directory which contains configurations for the site. Edit those as per your need.

6. Anything you put in the static directory will be directly available in the root of your website. It is the right place to put your favicon.ico or CNAME file.

7. You can start a hot-reloading development server while working on your site using the following command:

   docxy serve

8. Build the documentation when you're ready for deployment using the following command:

   docxy build

   This will build an optimized static site inside the build directory from your markdown pages ready for deployment to production.

   You can deploy it anywhere you want - GitHub Pages, GitLab Pages, DigitalOcean, AWS, GCP, Azure, Heroku, or your own server!

docgen's Issues

Upgrade dependencies

It has been a while since this was last updated, and most of the dependencies have been updated with new features in that time. So, upgrade them to the latest versions and refactor the code, if necessary, to fix any breaking changes.

Improvements : Switch monospaced font to JetBrains Mono and Add possibility to switch themes

Hi I like this project a lot documentation is very sleek and the website is very speedy. I would like to make some improvements if you want I can try make this changes myself :)

Pure dark mode!

A complete dark mode for the layout

Code highlighting

First of all, sweet project, looks promising!

I've noticed that for example here:
https://awesomedocs.traction.one/config

That even though there are several fields marked as 'yaml', they do not have code highlighting right now.

Hot reloading components

Hot-reloading on the markdown files are working perfectly fine.
But edits to the components themselves (add an element for example) doesn't appear to be hot-reloading.
Was this intentional? or is Gatsby borked? 😅

Migrate to eslint from tslint

Why?

A while back eslint integrated the parser from tslint and now supports linting TypeScript. And therefore tslint is now deprecated.

Resources

ESLint - https://eslint.org/
Reference ESLint config. for TypeScript - https://github.com/TheBastionBot/Locke/blob/master/.eslintrc.yml

Add sidebar support to small viewports

Properly support the sidebar (table of contents) in mobile view.

ship initial contents natively

Don't clone initial contents from external repo during initialization of awesomedocs.