Get Started with Docxy
Get started with Docxy and build your documentation application in a few minutes.
Step 1 - Create Docxy project
docxy create my-awesome-docs cd my-awesome-docs
This will create the
my-awesome-docs directory and populate it with the
initial files & configurations from the Docxy starter
This will create two directories
static inside the newly created
contents directory is where your documentation and Docxy
configuration lives. And anything you put inside the
static directory will be
available in the root of your website as static assets.
createcommand for some reason.
Step 2 - Initialize Docxy project
This will setup your project directory for Docxy development and install all the necessary dependencies required for the process.
Step 3 - Voilà 🎊
Your Docxy application is now ready.
This will start a development server and show you the local address where it can be accessed. Visit it to see a live preview of your Docxy application in your browser.
Step 4 - Write your heart out
Write your documentations using Markdown and put the files inside the
There's also the
config.yaml file inside the
contents directory which can be
used to configure and customize your Docxy application. See the
configuration docs for more details.
And any static assets you want to bundle with your application, you want put
them in the
static directory. These assets can be directly referened from
your markdown pages inside
Step 5 - Build for deployment
If you're done writing your documentation and now you want to deploy it to your preferred service, build your Docxy application using the following command:
This will build a blazing-fast production ready application from your
documentation in a few moments. It should be available inside the
directory once it's done.
You can then deploy the contents of the
build directory to any service you
want and your awesome new documentation website is now live!