View on GitHub

examples

examples.flatedit.com

logo.flatedit.com

examples.flatedit.com ✍

About flatedit ✍

creating documentation is not easy in hundreds of small 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

Documentation ✍

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

this is the frlatedit:

Dependencies

projects list readme1.txt

./DOCS/MENU.md
../bash/DOCS/TODO.md
./DOCS/FOOT.md

readme.sh

./flatedit/readme.md readme1.txt

Comments

With comments not to load this file

projects list readme2.txt

./DOCS/MENU.md
../bash/DOCS/TODO.md
./DOCS/FOOT.md

readme.sh

./flatedit/readme.md readme2.txt

Logs

Show not- & working/existing files

projects list readme3.txt

./DOCS/MENU.md
../bash/DOCS/TODO.md
./DOCS/FOOT.md

readme.sh

./flatedit/readme.md readme3.txt

Install flatedit ✍

Start

install

./install.sh

update

./update.sh

remove

./remove.sh

Contribution ✍

Install dependencies after created project

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

Install dependencies after created project

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

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

 ./readme

Config project file

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

Just change the first line in .apifork on projects.txt

projects.txt

install

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

./apifork install

OR

./apifork

update

./apifork update

remove

./apifork remove

Tags