JasperFx / marten

.NET Transactional Document DB and Event Store on PostgreSQL
https://martendb.io
MIT License
2.75k stars 429 forks source link

Explain how to update the docs including code snippets #3232

Closed AlexZeitler closed 2 months ago

mysticmind commented 2 months ago

@AlexZeitler with regards to the following:

Then you can refer to the code example in the Markdown file by using the following syntax:

<!-- snippet: sample_my_unique_name -->
<!-- endsnippet -->

you could add the same in code in some unit test file and use it.

AlexZeitler commented 2 months ago

@mysticmind makes sense - will do!

AlexZeitler commented 2 months ago

@mysticmind doing it and running mdsnippets or docs-build will compile the snippet into CONTRIBUTING.md.

image

Too bad MarkdownSnippets doesn't have an option to ignore single Markdown files.

AlexZeitler commented 2 months ago

I was already thinking about just adding a screenshot of the Markdown section

image

mysticmind commented 2 months ago

A screenshot is good enough and trivial to do!

AlexZeitler commented 2 months ago

@mysticmind Added the screenshot