A tool that allows you to generate static sites based off of text data.
This builds Octo so you can access it anywhere on your computer using the octo
command. If you don't want to install Octo globally, you can follow the non-global setup.
- Clone the repository
cd
into the folder- run
npm i
to install all dependencies - run
npm install -g .
- Clone the repository
cd
into the folder- run
npm i
to install all dependencies cd
into thebin
- run
node app
The -i or --input
flag means the input path. This will look for all texts files
with the given path. You can give a .txt file as input or a directory.
This is a required field for the program to work. Any files/directories with spaces should be
entered with quotes octo -i "Sherlock Holmes Selected Stories/test.txt"
.
Only text files work with this program.
This will take the content from the text file and output a HTML file.
octo -i test.txt
This will go though a directory named test and look for all nested .txt files.
octo -i test
The output allows the user to specify the path where the files/directories can be exported. This is not a required field and will default to './dist' if no option is given.
The -o or --output
flag means the output path. This will create a folder called htmlFiles outside of
the current directory.
octo -i test.txt -o ../hmtlFiles
If a input is a directory, Octo will recursively go through all the child directories and convert all the text files into HTML.