Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
rapid7
GitHub Repository: rapid7/metasploit-framework
 Path: blob/master/docs/README.md
31351 views

Metasploit docs site

This folder maintains the docs for https://docs.metasploit.com/ and https://github.com/rapid7/metasploit-framework/wiki

Architecture

How it works:

  • build.rb - The main entry point for generating the docs site from the old Github Wiki format files within metasploit-framework.wiki/

  • navigation.rb - Stores the mapping of metasploit-framework.wiki files to the website's navigational structure

  • metasploit-framework.wiki/ - The raw markdown documentation files. Modify these files when updating the site. These files originally came from https://github.com/rapid7/metasploit-framework/wiki

  • metasploit-framework.wiki.old/ - A separate clone of https://github.com/rapid7/metasploit-framework/wiki

Behind the scenes these docs are built and deployed to https://docs.metasploit.com/

Adding pages

You can modify existing documentation files within metasploit-framework.wiki/ with an editor of your choice and send a pull request. To add a new page, modify navigation.rb. Full details are found beside the NAVIGATION_CONFIG constant.

For linking to other docs the Github markdown syntax [[link text|relative_path_to_docs]] is used. Behind the scenes these links will be verified at build time to ensure there's no 404 links.

Note: It is also possible to use the syntax [[link text|relative_path_to_docs#section]] - but this navigation will happen client side, and there is no validation that these sections exist at build time. It is possible for future edits to a markdown file to break these links.

Setup

Developer build

Builds the latest docs content from the existing Metasploit Wiki, and serves the files locally:

cd metasploit-framework/docs

bundle install
bundle exec ruby build.rb --serve

Now visit http://127.0.0.1:4000

Production build

Builds the latest docs content from the existing Metasploit Wiki, creates a production Jekyll build, and serves the files locally:

cd metasploit-framework/docs

bundle install
bundle exec ruby build.rb --production --serve

Now visit http://127.0.0.1:4000/metasploit-framework/