Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs site to support mermaid #17357

Merged

Conversation

adfoster-r7
Copy link
Contributor

@adfoster-r7 adfoster-r7 commented Dec 11, 2022

Update the docs site to support mermaid graphs

Before

Mermaid code snippets render as text

image

After

Mermaid code snippets render as an svg

image

Verification

  • cd docs
  • bundle
  • bundle exec ruby build.rb --production --serve
  • Verify the mermaid charts render at http://localhost:4000/docs/development/propsals/java-meterpreter-feature-parity-proposal.html#supporting-native-system-calls

@gwillcox-r7
Copy link
Contributor

Nice I've been meaning to add some more charts to help document things on the website and was actually making some recently in my documentation. Will review this tomorrow and try get this in 👍

@gwillcox-r7 gwillcox-r7 self-assigned this Dec 12, 2022
@adfoster-r7 adfoster-r7 added the rn-documentation release notes for Metasploit Framework documentation label Dec 12, 2022
@gwillcox-r7
Copy link
Contributor

gwillcox-r7 commented Dec 12, 2022

Working like a charm and will be landing this now 🥳

@gwillcox-r7 gwillcox-r7 merged commit 8a68111 into rapid7:master Dec 12, 2022
@gwillcox-r7
Copy link
Contributor

Release Notes

The docs site has been updated to support mermaid graphs for rendering diagrams to assist with explanations.

@bwatters-r7 bwatters-r7 added the rn-enhancement release notes enhancement label Dec 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn-documentation release notes for Metasploit Framework documentation rn-enhancement release notes enhancement
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants