cgranleese-r7 aeafa4a756 Land #19088, Add docs for running and writing Metasploit's unit tests | 5 months ago | |
---|---|---|
.. | ||
_includes | 1 year ago | |
_plugins | 1 year ago | |
assets | 1 year ago | |
metasploit-framework.wiki | 5 months ago | |
.gitignore | 1 year ago | |
.ruby-gemset | 2 years ago | |
.ruby-version | 1 year ago | |
404.html | 2 years ago | |
CNAME | 2 years ago | |
Gemfile | 1 year ago | |
Gemfile.lock | 1 year ago | |
README.md | 1 year ago | |
_config.yml | 7 months ago | |
_config_development.yml | 2 years ago | |
_config_staging.yml | 1 year ago | |
build.rb | 1 year ago | |
navigation.rb | 6 months ago | |
robots.txt | 2 years ago |
This folder maintains the docs for https://docs.metasploit.com/ and https://github.com/rapid7/metasploit-framework/wiki
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 structuremetasploit-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/wikimetasploit-framework.wiki.old/
- A separate clone of https://github.com/rapid7/metasploit-framework/wikiBehind the scenes these docs are built and deployed to https://docs.metasploit.com/
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.
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
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