Building documentation instructions with mkdocs

bytedance / bhook

:fire: ByteHook is an Android PLT hook library which supports armeabi-v7a, arm64-v8a, x86 and x86_64.

https://github.com/bytedance/bhook/tree/main/doc#readme

MIT License

2.05k stars 315 forks source link

Building documentation instructions with mkdocs #76

Closed 5peak2me closed 1 year ago

5peak2me commented 1 year ago

the Feature, Motivation and Pitch

I see that https://github.com/bytedance/bhook/tree/main/doc#readme has documentation on its use, and I was wondering if it would be possible to use workflow to create mkdocs sites to publish to the gh-pages branch so that we could have a properly documented site.

Alternatives

Snipaste_2023-08-02_21-25-32

Additional context

No response

caikelun commented 1 year ago

doctree and outline of github web can also meet the demand?

5peak2me commented 1 year ago

looks good.