sdoc README

sdoc是辅助对markdown文档编写的插件

Features

主要功能：

1. 生成gitbook格式的SUMMARY.md
2. 自定义替换功能
   1. 可以帮你替换选中的文本，比如选中函数，替换生成函数注释模板（并提取函数名、参数、返回值）
   2. url编解码
   3. base64编解码
   4. 自定义的正则替换
3. 对c、c++实现callgraph的生成

待做的功能

• [ ] 生成compile_commands.json
• [ ] xx

Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• myExtension.enable: enable/disable this extension
• myExtension.thing: set to blah to do something

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

Users appreciate release notes as you update your extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

Note: You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
• Toggle preview (Shift+CMD+V on macOS or Shift+Ctrl+V on Windows and Linux)
• Press Ctrl+Space (Windows, Linux) or Cmd+Space (macOS) to see a list of Markdown snippets

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!