Skip to content

Commit

Permalink
add information about plugins to Reame
Browse files Browse the repository at this point in the history
  • Loading branch information
daynin committed Mar 29, 2023
1 parent 6859736 commit aa2366f
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ Fundoc supports [mdBook](https://github.com/rust-lang/mdBook), so if you want to
<img src="./images/full-text-search.gif" />
</p>

### Plugins

You can write your own plugins to enhance Fundoc's abilities. To do so, you can simply write a Lua plugin like this:

```lua
function transform(text)
importMermaid = '<script type="module"> import mermaid from "https://cdn.jsdelivr.net/npm/[email protected]/+esm"; mermaid.initialize({}); </script>'

result = '<pre class="mermaid">' .. text .. '</pre>' .. importMermaid
e
```

[Read more](https://daynin.github.io/fundoc/plugins.html) about plugins!

### Companies/projects who use Fundoc

- [Space Twistie](https://github.com/Space-Twistie)
Expand All @@ -115,6 +129,9 @@ You can use [Fundoc's GitHub Action](https://github.com/daynin/fundoc-action) to
- [x] Creating links to the source files from the documentation.
- [x] Generating mdBook with an ability to search through documentation.
- [x] Multi-repositories support (collecting all documentation fragments from different repos).
- [ ] Add Graphviz support
- [x] Add Mermaid support
- [x] Add a plugin-system
- [ ] Add file system API for the plugin system
- [ ] Add FFI for the plugin system
- [ ] Zettelkasten method support (maybe)

0 comments on commit aa2366f

Please sign in to comment.