Documentation

Documentation

  • Usage
  • Contribution
  • Development
  • API
  • F.A.Q.
  • Help
  • GitLab

›Development Guidelines

User Guide

  • User guide

Contribution Guidelines

  • Adding a tool/resource
  • Format conventions
  • Reporting issues
  • Suggesting enhancements

Development Guidelines

  • Installation and building
  • Directory structure
Edit

Installation and building

Inventory

Install dependencies:

$ npm install gulp-cli -g
$ npm install

Now you can simply build the site by using the following command:

$ gulp

The build output reside inside the build/ folder.

For example you can view it with Firefox:

$ firefox build/index.html

Documentation

Go inside the documentation folder:

$ cd docusaurus

Install dependencies:

$ npm install

Build the documentation:

$ npm run build

You can manually browse it in the build/ (docusaurus/build/) folder or run npm start (or yarn start if you have it installed).

For more information on how the documentation works, check Docusaurus website.

← Suggesting enhancementsDirectory structure →
  • Inventory
  • Documentation
Documentation
Docs
User GuideContribution GuidelinesDevelopment GuidelinesAPI ReferenceF.A.Q.
Community and Social
DiscordTwitter (Rawsec)Twitter (Rawsec bot)Twitter (noraj: Rawsec's captain)
Source
SourceSource mirror
Rawsec's CyberSecurity Inventory
Copyright © 2021 Rawsec