fa3ec4a1b8 | ||
---|---|---|
.. | ||
_includes | ||
assets/images | ||
.gitignore | ||
.ruby-gemset | ||
.ruby-version | ||
404.html | ||
Gemfile | ||
Gemfile.lock | ||
README.md | ||
_config.yml | ||
_config_development.yml | ||
build.rb | ||
robots.txt |
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.