Skip to content

Commit 3f922df

Browse files
adfoster-r7adfoster-r7
committed
Add initial metasploit docs site, generated from the existing wiki
1 parent ce6f22f commit 3f922df

File tree

11 files changed

+1345
-0
lines changed

11 files changed

+1345
-0
lines changed

‎docs/.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor
6+
7+
# These files will be generated by build.rb and do not need to be committed
8+
Generated for now
9+
docs
10+
metasploit-framework.wiki
11+
Index.md

‎docs/.ruby-gemset

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
metasploit-framework-docs

‎docs/.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.0.2

‎docs/404.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: default
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎docs/Gemfile

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
source 'https://rubygems.org'
2+
3+
gem 'jekyll', '~> 4.2.0'
4+
gem 'just-the-docs', github: 'adfoster-r7/just-the-docs', branch: 'r7_ver_custom'
5+
gem 'webrick'
6+
7+
group :jekyll_plugins do
8+
gem 'jekyll-sitemap'
9+
end
10+
11+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
12+
# and associated library.
13+
platforms :mingw, :x64_mingw, :mswin, :jruby do
14+
gem 'tzinfo', '~> 1.2'
15+
gem 'tzinfo-data'
16+
end
17+
18+
# Performance-booster for watching directories on Windows
19+
gem 'wdm', '~> 0.1.1', platforms: %i[mingw x64_mingw mswin]
20+
21+
group :development do
22+
gem 'pry-byebug'
23+
end

‎docs/Gemfile.lock

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
GIT
2+
remote: https://github.com/adfoster-r7/just-the-docs.git
3+
revision: 71772286f92421332a29c75765e7af86402db581
4+
branch: r7_ver_custom
5+
specs:
6+
just-the-docs (0.3.3)
7+
jekyll (>= 3.8.5)
8+
jekyll-include-cache (>= 0.2.1)
9+
jekyll-seo-tag (>= 2.0)
10+
rake (>= 12.3.1)
11+
12+
GEM
13+
remote: https://rubygems.org/
14+
specs:
15+
addressable (2.8.0)
16+
public_suffix (>= 2.0.2, < 5.0)
17+
byebug (11.1.3)
18+
coderay (1.1.3)
19+
colorator (1.1.0)
20+
concurrent-ruby (1.1.9)
21+
em-websocket (0.5.3)
22+
eventmachine (>= 0.12.9)
23+
http_parser.rb (~> 0)
24+
eventmachine (1.2.7)
25+
ffi (1.15.4)
26+
forwardable-extended (2.6.0)
27+
http_parser.rb (0.8.0)
28+
i18n (1.8.11)
29+
concurrent-ruby (~> 1.0)
30+
jekyll (4.2.1)
31+
addressable (~> 2.4)
32+
colorator (~> 1.0)
33+
em-websocket (~> 0.5)
34+
i18n (~> 1.0)
35+
jekyll-sass-converter (~> 2.0)
36+
jekyll-watch (~> 2.0)
37+
kramdown (~> 2.3)
38+
kramdown-parser-gfm (~> 1.0)
39+
liquid (~> 4.0)
40+
mercenary (~> 0.4.0)
41+
pathutil (~> 0.9)
42+
rouge (~> 3.0)
43+
safe_yaml (~> 1.0)
44+
terminal-table (~> 2.0)
45+
jekyll-include-cache (0.2.1)
46+
jekyll (>= 3.7, < 5.0)
47+
jekyll-sass-converter (2.1.0)
48+
sassc (> 2.0.1, < 3.0)
49+
jekyll-seo-tag (2.7.1)
50+
jekyll (>= 3.8, < 5.0)
51+
jekyll-sitemap (1.4.0)
52+
jekyll (>= 3.7, < 5.0)
53+
jekyll-watch (2.2.1)
54+
listen (~> 3.0)
55+
kramdown (2.3.1)
56+
rexml
57+
kramdown-parser-gfm (1.1.0)
58+
kramdown (~> 2.0)
59+
liquid (4.0.3)
60+
listen (3.7.0)
61+
rb-fsevent (~> 0.10, >= 0.10.3)
62+
rb-inotify (~> 0.9, >= 0.9.10)
63+
mercenary (0.4.0)
64+
method_source (1.0.0)
65+
pathutil (0.16.2)
66+
forwardable-extended (~> 2.6)
67+
pry (0.13.1)
68+
coderay (~> 1.1)
69+
method_source (~> 1.0)
70+
pry-byebug (3.9.0)
71+
byebug (~> 11.0)
72+
pry (~> 0.13.0)
73+
public_suffix (4.0.6)
74+
rake (13.0.6)
75+
rb-fsevent (0.11.0)
76+
rb-inotify (0.10.1)
77+
ffi (~> 1.0)
78+
rexml (3.2.5)
79+
rouge (3.26.1)
80+
safe_yaml (1.0.5)
81+
sassc (2.4.0)
82+
ffi (~> 1.9)
83+
terminal-table (2.0.0)
84+
unicode-display_width (~> 1.1, >= 1.1.1)
85+
unicode-display_width (1.8.0)
86+
webrick (1.7.0)
87+
88+
PLATFORMS
89+
ruby
90+
91+
DEPENDENCIES
92+
jekyll (~> 4.2.0)
93+
jekyll-sitemap
94+
just-the-docs!
95+
pry-byebug
96+
tzinfo (~> 1.2)
97+
tzinfo-data
98+
wdm (~> 0.1.1)
99+
webrick
100+
101+
BUNDLED WITH
102+
2.2.22

‎docs/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Metasploit docs site
2+
3+
## Setup
4+
5+
### Build content
6+
7+
First build the latest docs content from the existing [Metasploit Wiki](https://github.com/rapid7/metasploit-framework/wiki). This a temporary
8+
solution until the docs content is directly committed to the [metasploit-framework](https://github.com/rapid7/metasploit-framework) repository.
9+
10+
```
11+
bundle install
12+
bundle exec ruby build.rb
13+
```
14+
15+
### Running
16+
17+
Running:
18+
19+
```
20+
bundle install
21+
bundle exec jekyll serve --config _config.yml,_config_development.yml --incremental
22+
```
23+
24+
Now visit http://127.0.0.1:4000
25+
26+
### Production build
27+
28+
Testing production build:
29+
```
30+
rm -rf _site
31+
bundle install
32+
bundle exec ruby build.rb
33+
JEKYLL_ENV=production jekyll build
34+
```
35+
36+
### Modifying pages
37+
38+
**Note** - to modify pages, for now, the changes will need to be made to [Metasploit Wiki](https://github.com/rapid7/metasploit-framework/wiki).
39+
However the `docs` folder can be edited locally. Jekyll will rebuild the required file, and the changes can be seen after refreshing your browser.
40+
41+
When adding test files locally, Jekyll will not always regenerate the navigation for all pages. It is easier to regenerate the entire site again:
42+
43+
```
44+
rm -rf _site
45+
bundle exec jekyll serve --config _config.yml,_config_development.yml --incremental
46+
```

‎docs/_config.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
title: Metasploit
2+
baseurl: '/metasploit-framework'
3+
url: ''
4+
5+
permalink: pretty
6+
7+
heading_anchors: true
8+
aux_links_new_tab: true
9+
aux_links:
10+
'Metasploit Framework on GitHub':
11+
- '//github.com/rapid7/metasploit-framework'
12+
13+
nav_cache: true
14+
15+
gh_edit_link: true
16+
gh_edit_link_text: 'Edit this page on GitHub'
17+
gh_edit_repository: 'https://github.com/rapid7/metasploit-framework'
18+
gh_edit_branch: 'master'
19+
gh_edit_source: docs
20+
gh_edit_view_mode: 'tree'
21+
22+
ga_tracking: UA-4622520-7
23+
ga_tracking_anonymize_ip: true
24+
25+
# Build settings
26+
theme: just-the-docs
27+
plugins:
28+
- jekyll-sitemap
29+
- jekyll-seo-tag
30+
31+
back_to_top: true
32+
back_to_top_text: 'Back to top'
33+
34+
compress_html:
35+
clippings: all
36+
comments: all
37+
endings: all
38+
startings: []
39+
blanklines: false
40+
profile: false
41+
ignore:
42+
envs: development
43+
44+
exclude:
45+
- '*.rb'
46+
- metasploit-framework.wiki
47+
- README.md
48+
49+
just_the_docs:
50+
collections: []
51+
52+
ignore_theme_config: true

‎docs/_config_development.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
baseurl: ''
2+
ga_tracking: ''

0 commit comments

Comments
 (0)