tldw
Overwrites the readme based on info fetched from package.json and source code.
Opinionated
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
npm install --global tldw@^7.3.1
yarn global add tldw@^7.3.1Usage
Generated readme can be extended with following files in your repository:
Config
readme/config.yml
YAML representation of Markdown fragments
-
readme/envVars.yml(same asreadme/config.yml#environmentVariables) readme/usageOptions.yml
JavaScript fragments
readme/example.jsreadme/result*.js
Markdown fragments
readme/legal.mdreadme/warning.mdreadme/usage.mdreadme/advancedUsage.mdreadme/example.mdreadme/options.mdreadme/development.mdreadme/description.mdreadme/result.mdreadme/notes.mdreadme/related.mdreadme/faq.md
CLI Usage
After installing package tldw globally, you can use its command line interface.
tldwFor usage instructions:
tldw --helpDevelopment
Development hints for maintaining and improving tldw
Setting up:
git clone git@github.com:jaid/tldw.git
cd tldw
npm installTesting:
npm run test:devTesting in production environment:
npm run testLicense
MIT License
Copyright © 2021, Jaid <jaid.jsx@gmail.com> (https://github.com/jaid)