History

Dnidof c117040705 Fix typo: Replace patten with pattern Update How-to-Apply-to-GSoC.md		2022-12-26 16:37:59 +01:00
..
_includes	Add favicon, guidelines to the nav, remove edit link, and cruft	2021-12-02 03:32:08 +00:00
assets/images	Add favicon, guidelines to the nav, remove edit link, and cruft	2021-12-02 03:32:08 +00:00
metasploit-framework.wiki	Fix typo: Replace patten with pattern	2022-12-26 16:37:59 +01:00
.gitignore	Update docs site to use migrated wiki files	2022-05-20 13:13:28 +01: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	Simplify contributing steps	2022-05-19 16:10:47 +01:00
_config.yml	Update docs site to support mermaid	2022-12-11 01:22:30 +00:00
_config_development.yml	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +00:00
build.rb	Add Meterpreter reg command documentation	2022-10-25 19:45:01 +01:00
navigation.rb	Add Meterpreter reg command documentation	2022-10-25 19:45:01 +01: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/

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/

Contributing Documentation

You can modify existing documentation files within metasploit-framework.wiki/ with an editor of your choice and send a pull request. Note that adding a new page will also require modifying navigation.rb to appear on the navigation menu.