Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaid/tldw
Overwrites the readme based on info fetched from package.json and source code.
https://github.com/jaid/tldw
documentation github jsx markdown react react-renderer readme readme-template
Last synced: 19 days ago
JSON representation
Overwrites the readme based on info fetched from package.json and source code.
- Host: GitHub
- URL: https://github.com/jaid/tldw
- Owner: Jaid
- License: mit
- Created: 2019-02-01T23:46:15.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-03-08T04:38:22.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T14:49:32.176Z (9 months ago)
- Topics: documentation, github, jsx, markdown, react, react-renderer, readme, readme-template
- Language: JavaScript
- Homepage: https://github.com/jaid/tldw
- Size: 8.55 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license.txt
Awesome Lists containing this project
README
# tldw
**Overwrites the readme based on info fetched from package.json and source code.**
#### Opinionated
:warning: This project is tailored to my personal needs and workflows and therefore highly opinionated. Feel free to use it or get inspired by it, but please do not get frustrated if you come across weird features or difficulties integrating it in your own ecosystem.
## Installation
```bash
npm install --global tldw@^7.3.1
```
```bash
yarn global add tldw@^7.3.1
```
## Usage
Generated readme can be extended with following files in your repository:
##### Config
- `readme/config.yml`
##### YAML representation of Markdown fragments
- `readme/envVars.yml` (same as `readme/config.yml#environmentVariables`)
- `readme/usageOptions.yml`
##### JavaScript fragments
- `readme/example.js`
- `readme/result*.js`
##### Markdown fragments
- `readme/legal.md`
- `readme/warning.md`
- `readme/usage.md`
- `readme/advancedUsage.md`
- `readme/example.md`
- `readme/options.md`
- `readme/development.md`
- `readme/description.md`
- `readme/result.md`
- `readme/notes.md`
- `readme/related.md`
- `readme/faq.md`
## CLI Usage
After installing package `tldw` globally, you can use its command line interface.
```bash
tldw
```
For usage instructions:
```bash
tldw --help
```
## Development
Development hints for maintaining and improving tldw
Setting up:
```bash
git clone [email protected]:jaid/tldw.git
cd tldw
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```
## License
[MIT License](https://raw.githubusercontent.com/jaid/tldw/master/license.txt)
Copyright © 2021, Jaid \ (https://github.com/jaid)