https://github.com/docxy/docgen

Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.
https://github.com/docxy/docgen

awesomedocs docgen documentation-generator docxy gatsbyjs hacktoberfest markdown reactjs

Last synced: 19 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/docxy/docgen
• Owner: docxy
• License: mpl-2.0
• Created: 2018-09-16T05:18:59.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-04-04T14:11:14.000Z (over 1 year ago)
• Last Synced: 2024-10-02T09:14:23.655Z (about 1 month ago)
• Topics: awesomedocs, docgen, documentation-generator, docxy, gatsbyjs, hacktoberfest, markdown, reactjs
• Language: TypeScript
• Homepage: https://docxy.traction.one/
• Size: 3.8 MB
• Stars: 52
• Watchers: 2
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - docgen - Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown. (TypeScript)
• awesome-starred - docxy/docgen - Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown. (reactjs)

README

        


    

    
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]

1.  Create your [Docxy] project:

    ```bash

    docxy create my-awesome-docs

    ```

1.  Initialize [Docxy] in the project directory:

    ```bash

    cd my-awesome-docs

    docxy init

    ```

1.  Add markdown pages in the `contents` directory which will serve as your

    documentation pages. You'll find two example pages already in there.

1.  Edit the `config.yaml` file in the `contents` directory which contains

    configurations for the site. Edit those as per your need.

1.  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.

1.  You can start a hot-reloading development server while working on your site

    using the following command:

    ```bash

    docxy serve

    ```

1.  Build the documentation when you're ready for deployment using the following

    command:

    ```bash

    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](https://pages.github.com),

    [GitLab Pages](https://gitlab.com/pages), [DigitalOcean](https://m.do.co/c/0ee6cb9c7ee0),

    AWS, GCP, Azure, Heroku, or your own server!

[Node.js]: https://nodejs.org/

[Git]: https://git-scm.com

[Docxy]: https://github.com/docxy/docgen

[Docxy CLI]: https://github.com/docxy/docxy