A document-code sync tools for document engineering.

Related tags

Overview

Writing

A document-code sync tools for document engineering. Writing 是一个自动 “文档-代码” 同步工具。解析 Markdown 中的代码定义，读取目标代码，并嵌入到新的文档中。

Language parse support by guarding with tree-sitter， current supported language: Java, JavaScript, Rust

Usage

Install

install with Rust Cargo

cargo install writing

or download from: release

Run

usage:

writing -p README.md

all command:

OPTIONS:
    -h, --help               Print help information
    -i, --input <INPUT>      [default: README.md]
    -o, --output <OUTPUT>    [default: out.md]
    -V, --version            Print version information

Samples

by Lines

// doc-code: file("src/lib.rs").line()[1, 5]

by Section

// doc-section: file("src/lib.rs").section("section1")

by Function

// doc-func: file("src/lib.rs").func()["pre_process_file", "process_file"]

```graphviz?
Graphviz
```

Development

setup:

git clone https://github.com/inherd/writing
cargo build

others: parser with pest

process:

read markdown file
filter by line with ends_with // doc-***
parse // doc-** from [writing.pest](src/parser/writing.pest)
read code
generate output

Grammar

see in writing.pest

Documents

API 库的文档体系支持：主流编程语言的文档设计

文档工程体验设计：重塑开发者体验

License

@ 2021 This code is distributed under the MIT license. See LICENSE in this directory.

Postgres proxy which allows tools that don't natively supports IAM auth to connect to AWS RDS instances.

rds-iamauth-proxy rds-proxy lets you make use of IAM-based authentication to AWS RDS instances from tools that don't natively support that method of a

10 Nov 7, 2022

PM-Tools - a simple Rust util to easily create server directories

PM-Tools PM-Tools is a simple Rust util to easily create server directories or plugins without the hassle of unzipping or creating directories Progres

2 Mar 19, 2022

Boot tools: loader, image generator, etc as a library crate

ArcBoot v0 A uefi bootloader for riscv, arm and x86. Comes in the form of a single executable. the source code contains a single executable target and

3 Oct 3, 2022

Middlewares and tools to integrate axum + tracing + opentelemetry

axum-tracing-opentelemetry Middlewares and tools to integrate axum + tracing + opentelemetry. Read OpenTelemetry header from incoming request Start a

31 Jan 4, 2023

Migrate C code to Rust

C2Rust helps you migrate C99-compliant code to Rust. The translator (or transpiler) produces unsafe Rust code that closely mirrors the input C code. T

3k Jan 8, 2023

Mix async code with CPU-heavy thread pools using Tokio + Rayon

tokio-rayon Mix async code with CPU-heavy thread pools using Tokio + Rayon Resources Documentation crates.io TL;DR Sometimes, you're doing async stuff