This is a CLI for Docxy.
Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.
The Docxy CLI is used to:
- Create and initialize a Docxy application
- Spin up a hot-reloading local development server
- Build a production-ready website ready for deployment
You can install the Docxy CLI in one of the two ways mentioned below.
Note that, you need to have Go installed for this.
You can directly install it from source simply by running the following command:
go get -u github.com/docxy/docxy
This will automatically install docxy
globally.
You can directly get the updated version of the Docxy CLI
binaries from GitHub Releases,
and place it somewhere in your $PATH
so that you can access the docxy
command from anywhere.
After installation, it can be accessed globally using the
docxy
command.
Usage:
docxy [command]
Available Commands:
help Help about any command
create Creates a Docxy project
init Initializes a Docxy project
serve Starts the development server
build Builds the Docxy website
Flags:
-h, --help help for docxy
Use "docxy [command] --help" for more information about a command.
Any and all contributions are welcomed.
If you want to contribute code, you need to have a development environment set up for working with Go.
Copyright © 2020 Sankarsan Kampa
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.