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.

Sign up for GitHub

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

Mention that bootstrap Markdown extensions should be enabled #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Mention that bootstrap Markdown extensions should be enabled #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ These are theme-specific settings and can be set in a settings file (in addition
- `Logo`: The logo file to use in the navigation bar (include a leading slash if providing a relative path). If not provided, the `SiteTitle` will be used.
- `EditRoot`: The root link to use for editing pages, usually set to a value like `https://github.com/org/repo/edit/develop/input` (do not use a trailing slash).

Since this theme is based on Bootstrap the `MarkdownExtensions` setting should be set to `bootstrap` to enable the [Markdig Bootstrap extension](https://github.com/xoofx/markdig/blob/master/src/Markdig.Tests/Specs/BootstrapSpecs.md).
Enabling this extension ensure that images have the proper width and tables, blockquotes and figures are styled.

### Colors

The following settings control the color scheme of the theme. For any that are not defined, the default Bootstrap values will be used.
Expand Down