Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.34 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.34 KB
Raw

Quick start

Install from GitHub

git clone https://github.com/swimlane/docspa-starter.git
cd docspa-starter
npm install
npm start

i> If you want to hack on DocSPA core components clone https://github.com/swimlane/DocSPA instead. If you would like to setup DocSPA in your own angular cli app see angular-cli-install.

View Your Site

npm start

At that point you will see a message to "open your browser on http://localhost:4200/"

Customization

This DocSPA instance can be modified change configuration to teh various DocSPA modules. See module for details on each module and configuration options.

Writing Content

Modify content in the 'src/docs' directory. See content for more details.

Deploy to gh-pages

npm run deploy

Credits

DocSPA is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.

DocSPA was developed in Angular following inspiration from docsify by QingWei-Li and contributors.