https://github.com/chinanf-boy/doc-templite
code: < doc-templite > multi-file with templite tool ❤️ is work ✅
https://github.com/chinanf-boy/doc-templite
mds templite toml
Last synced: 6 months ago
JSON representation
code: < doc-templite > multi-file with templite tool ❤️ is work ✅
- Host: GitHub
- URL: https://github.com/chinanf-boy/doc-templite
- Owner: chinanf-boy
- License: mit
- Created: 2018-08-15T02:12:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T09:44:13.000Z (almost 3 years ago)
- Last Synced: 2025-03-16T11:07:41.763Z (7 months ago)
- Topics: mds, templite, toml
- Language: JavaScript
- Homepage:
- Size: 790 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# doc-templite [](https://travis-ci.org/chinanf-boy/doc-templite) [](https://codecov.io/gh/chinanf-boy/doc-templite?branch=master) [](https://github.com/chinanf-boy/doc-templite-explain)
templite tool for Multi-md files
> while we work with Multi-file/repos-readme.md, some style help us to say or show something ,like a md table , but next time i want a md link. too busy to change those files, So `doc-templite` maybe help.
[中文](./readme.zh.md) | [english](./readme.md)
## created✅
## Install
```
npm i -g doc-templite
```
## Example
### 1. change file `readme.md` 👇 must got doc-templite tag
```html
```
> Note: in START-END block, we use toml and with ``
> Multi-line only allow **one**, Single-line can **more**
### 2. need templite file `.doc-templite.js` in cli pwd
> readme field match `` of `1. readme.md`
```js
module.exports = {
readme: `name | age
---------|----------
{{ name }} | {{ age }}`,
};
```
> NOTE: default `docTempliteId === 'readme'`
### 3. run cli `doc-templite .` with `.doc-templite.js` dir
> search all file , but only work with **doc-templite tag**
```
doc-templite .
```
### 4. done , and the `readme.md` file content change
```
name | age
---------|----------
yobrave | 18
```
| name | age |
| ------- | --- |
| yobrave | 18 |
## CLI
```
npm install --global doc-templite
```
```
Usage
$ doc-templite [folder/file name] [Optioins]
Example
$ doc-templite readme.md
⭐ [Options]
-D debug
⭐ [High Options]
--OR only Read, no reWrite files
```
## concat
- [find-files-rust](https://github.com/chinanf-boy/find-files-rust) rust crate(ignore) power for Search all file in Current Dir
- [doctoc](https://github.com/thlorenz/doctoc) Generates table of contents for markdown files
- [templite](https://github.com/lukeed/templite) Lightweight templating in 150 bytes
- [toml](https://github.com/toml-lang/toml) Tom's Obvious, Minimal Language
## License
MIT © [chinanf-boy](http://llever.com)