josefpihrt/josefpihrt.github.io

Documentation for Roslynator, DotMarkdown, Orang and other projects.

josefpihrt.github.io

This website contains documentation for following projects:

• Roslynator
• DotMarkdown
• Orang
• Snippetica

This website is built using Docusaurus 2, a modern static website generator.

Generate Documentation

For local development it's necessary to pull following repositories and place them next to this repository:

• Roslynator
• DotMarkdown
• Orang
• Snippetica

Folder structure (example):

• code
  • josefpihrt.github.io
  • roslynator (required name)
  • dotmarkdown (required name)
  • orang (required name)
  • snippetica (required name)

Then run script tools/generate_docs.ps1 (generated documentation can be deleted with script tools/delete_docs.ps1).

Local Development

Run npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

Run npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

josefpihrt.github.io's Issues

Add page "How to spellcheck a project"

Download artifacts from other repos instead of checkouting the repos

Invalid link

https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0014/

Points to https://josefpihrt.github.io/docs/roslynator/analyzers/RCS0014/RCS0061

Add search bar