History

adfoster-r7 40956bf5b1 Generate links to new docs site		2022-02-11 12:55:04 +00: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
.gitignore	Code quality, linting, and ensuring new paths are alphanumeric	2021-12-15 00:24:03 +00:00
.ruby-gemset	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +00:00
.ruby-version	Add initial metasploit docs site, generated from the existing wiki	2021-12-01 03:07:03 +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	Use Rapid7 fork for just-the-docs	2022-01-06 10:59:29 +00:00
Gemfile.lock	Use Rapid7 fork for just-the-docs	2022-01-06 10:59:29 +00:00
README.md	Add explicit step for ensuring the user is in the right directory	2021-12-15 16:15:28 +00:00
_config.yml	Add cname to metasploit docs	2022-02-10 23:46:47 +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	Generate links to new docs site	2022-02-11 12:55:04 +00: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

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/

Modifying pages

Note - to modify pages, for now, the changes will need to be made to Metasploit Wiki. However the docs folder can be edited locally. Jekyll will rebuild the required file, and the changes can be seen after refreshing your browser.

When adding test files locally, Jekyll will not always regenerate the navigation for all pages. It is easier to rebuild the entire site again.