Skip to content

Commit

Permalink
Fix to not run mdsnippets on readm e file [skip ci]
Browse files Browse the repository at this point in the history
- Fix to not run mdsnippets on readme file
- Update mdsnippets config to fail on missing code snippets
  • Loading branch information
mysticmind committed Jul 12, 2021
1 parent 8235641 commit caa5978
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,10 @@ All code snippet identifier starts with `sample_` as a convention to clearly ide

- Use the below steps to include the code snippet in a docs page

```markdown
<!-- snippet: sample_my_snippet -->
<!-- endSnippet -->
```
<pre>
&#60;!-- snippet: sample_my_snippet -->
&#60;!-- endSnippet -->
</pre>

Note that when you run the docs locally, the above placeholder block in the Markdown file will get updated inline with the actual code snippet from the source code. Please ensure to commit the changes with the inline code snippet intact. This helps with easier change tracking when you send PR's.

Expand Down
2 changes: 1 addition & 1 deletion mdsnippets.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
"UrlPrefix": "https://github.com/JasperFx/marten/blob/master",
"ExcludeMarkdownDirectories": ["documentation", "planning", "./src/DinnerParty"],
"ExcludeSnippetDirectories": ["./src/Marten", "./src/CommandLineRunner", "./src/DinnerParty", "./src/EventPublisher", "./src/EventSourceWorker", "./src/Marten", "./src/Marten.CommandLine", "./src/Marten.NodaTime", "./src/Marten.PLv8", "Marten.Storyteller", "./src/MartenBenchmarks", "./src/StorytellerRunner"],
"TreatMissingAsWarning": true
"TreatMissingAsWarning": false
}

0 comments on commit caa5978

Please sign in to comment.