Create a wizard using the CLI to guide the user on how to install and do a basic setup.
Guide
Install
Install Node.js on your computer and the from the console or terminal go to your project folder and use npm to install DocumentCSS:
> cd path/to/myproject
> npm install doccss
You will then will be prompted to enter the path to the folder you want documentCSS to parse for documentation. Enter the desired location.
> Enter the path to source files to be parsed for documentation: (ex: src/styles/)
> src
Following you will be prompted to enter the path where you want to store the generated documentation. Enter the desired location.
> Enter the path to location where to store docs: (ex: src/)
> src/styles
With this information DocumentCSS will generate a style guide with boilerplate content for the Homepage and Styles pages. Use these as a reference to create more documentation.
You will then see the following message:
Access your style guide at: http://localhost:8080/docs
DocumentCSS has created for you the following:
- scr/styleguide/pages → store here documentation outside of you code using markdown files.
- scr/styleguide/theme → customize the appearance of your style guide by modifying these files.
Customize these settings in config.json
Create a wizard using the CLI to guide the user on how to install and do a basic setup.
Guide
Install
Install Node.js on your computer and the from the console or terminal go to your project folder and use
npmto install DocumentCSS:You will then will be prompted to enter the path to the folder you want documentCSS to parse for documentation. Enter the desired location.
Following you will be prompted to enter the path where you want to store the generated documentation. Enter the desired location.
With this information DocumentCSS will generate a style guide with boilerplate content for the Homepage and Styles pages. Use these as a reference to create more documentation.
You will then see the following message: