History

Grant Willcox ae4e616c3b Update Navigating-And-Undstanding-Metasploits-Codebase to add new code navigation tools and debugging tools Move debugging info into same file and make markdown match standards Add more info on Pry debugging using Alan David Foster's explaination Fix up broken URL links and format new URL links correctly Fix up formatting and add information on Debug.gem supported commands		2023-06-09 09:17:46 -05:00
..
_includes	Improve UX of module explorer	2023-02-21 12:06:24 +00:00
_plugins	Improve UX of module explorer	2023-02-21 12:06:24 +00:00
assets	Improve UX of module explorer	2023-02-21 12:06:24 +00:00
metasploit-framework.wiki	Update Navigating-And-Undstanding-Metasploits-Codebase to add new code navigation tools and debugging tools	2023-06-09 09:17:46 -05:00
.gitignore	Add additional kerberos documentation	2023-01-18 16:58:34 +00:00
.ruby-gemset	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +00:00
.ruby-version	Bump docs ruby version to 3.0.5	2022-12-12 17:28:29 +00:00
404.html	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +00:00
CNAME	Add cname to metasploit docs	2022-02-10 23:46:47 +00:00
Gemfile	Update docs site to support mermaid	2022-12-11 01:22:30 +00:00
Gemfile.lock	Update docs site to support mermaid	2022-12-11 01:22:30 +00:00
README.md	Update docs to support links with anchors	2023-01-25 12:16:15 +00:00
_config.yml	Add edit link to docs website	2023-01-13 14:01:40 +00:00
_config_development.yml	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +00:00
_config_staging.yml	Add additional documentation for mssql and ldap	2023-01-23 11:46:51 +00:00
build.rb	Remove instance variables from example code	2023-04-03 11:30:03 +02:00
navigation.rb	Land #17965 , add module for AD CS cert management	2023-05-22 09:50:53 -05:00
robots.txt	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +00:00

README.md

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.

Adding links

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/