writing

Crates.iowriting
lib.rswriting
version0.2.1
sourcesrc
created_at2021-09-18 12:49:28.318257
updated_at2021-10-22 12:52:07.503179
descriptionWriting, is a simple tool for code-document sync.
homepagehttps://github.com/inherd/forming
repositoryhttps://github.com/inherd/forming
max_upload_size
id453296
size35,325
Fengda Huang (phodal)

documentation

https://github.com/inherd/forming

README

Writing

a document-code sync tools for setup.

process

  1. read markdown file
  2. parse markdown code
  3. insert new code
  4. generate new code

DSL Design

by Lines

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

by Section (Todo)

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

by Function (Todo)

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

Documents

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

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

License

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

Commit count: 286

cargo fmt