www

logo.flatedit.com

docs.flatedit.com

About flatedit

creating documentation is not easy in hundreds of projects, where are dependencies we need some simple tool to manage the documentation from the terminal, during programming

this is the FlatEdit to help You manage the content of many projects

file of projects list:

Contribution

Fast Install

curl https://raw.githubusercontent.com/flatedit/bash/main/flatedit.sh -o flatedit
./flatedit init

Install dependencies after created project

curl https://raw.githubusercontent.com/flatedit/bash/main/flatedit.sh -o flatedit
echo "https://github.com/flatedit/bash.git flatedit" > "flatedit.dev.txt"
./flatedit install flatedit.dev.txt

install

minsungson/GitHub-cURL: A guide to installing files from GitHub repos in terminal using cURL

./flatedit install

OR

./flatedit

init

./flatedit init

update

./flatedit update

remove

./flatedit remove

Contribution

Solutions for development:

Install

Install dependencies after created project

curl https://raw.githubusercontent.com/flatedit/bash/main/flatedit.sh -o flatedit
echo "https://github.com/flatedit/bash.git flatedit" > "flatedit.dev.txt"
./flatedit install flatedit.dev.txt

Install package list after created project

curl https://raw.githubusercontent.com/apipackage/bash/main/apipackage.sh -o apipackage
echo "https://github.com/letwhois/bash apidsl/apidsl/bash letwhois" >> "apipackage.txt"
./apipackage install

Edit documentation with flatedit

echo "#!/bin/bash" > "readme"
echo "./flatedit/readme.sh readme.txt" > "readme"
echo "./DOCS/MENU.md" >> "readme.txt"
echo "./DOCS/ABOUT.md" >> "readme.txt"
echo "./DOCS/FOOT.md" >> "readme.txt"

Update documentation

 ./flatedit

Config project file

The config file: .flatedit can be another, e.g. flatedit.txt

Just change the first line in .flatedit on flatedit.txt

flatedit.txt

TODO list of flatedit

ASCIIFlow

website ASCIIFlow github lewish/asciiflow: ASCIIFlow

Textik

website Textik - ASCII diagrams editor github flatedit/tixi: Ascii charts editor

Tags