ClickHouse / clickhouse-docs

Official documentation for ClickHouse
https://clickhouse.com/docs
Other
114 stars 268 forks source link

research including named sections of source code into docs #219

Closed DanRoscigno closed 2 years ago

DanRoscigno commented 2 years ago

A plugin that Docusaurus uses themselves for their changelog: https://github.com/facebook/docusaurus/blob/main/website/src/plugins/changelog/index.js

Another from Docusaurus for feature requests: https://github.com/facebook/docusaurus/tree/main/website/src/plugins/featureRequests

A plugin that does what we need, but I can't get it working :) https://github.com/jknoxville/remark-code-snippets

Plugin docs: https://docusaurus.io/docs/advanced/plugins

Source for the admonitions plugin: https://github.com/elviswolcott/remark-admonitions

Community plugins: https://docusaurus.io/community/resources#community-plugins

Codeblock plugin that pulls by line number from github: https://github.com/saucelabs/docusaurus-theme-github-codeblock

A plugin that pulls remote markdown files: https://github.com/rdilweb/docusaurus-plugin-remote-content

Some Docusaurus plugins: https://github.com/jodyheavener?tab=repositories

An example remark plugin, not specific to Docusaurus: https://github.com/johno/egghead-lessons/tree/master/remark-plugin and video: https://egghead.io/lessons/javascript-create-a-remark-plugin-to-modify-markdown-headings

Docusaurus discord: https://discord.com/channels/398180168688074762/877243736806019102/919599591345778688

DanRoscigno commented 2 years ago

Preprocess with awk https://stackoverflow.com/questions/56083661/using-awk-to-get-lines-between-two-patterns

DanRoscigno commented 2 years ago

not possible without custom code. Closing