bitovi / bitovi/documentcss

CLI - Generator

Open
#58 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
73
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Create a wizard using the CLI to guide the user on how to install and do a basic setup.

----
## Guide

### Install
Install [Node.js](url) 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.