kaveh

a simple website generator
git clone git://mahdi.pw/kaveh.git
Log | Files | Refs | README | LICENSE

README (819B)

      1 kaveh
      2 =====
      3 kaveh is a simple website generator, it aims to generate static html files from markdown files, no databases and bloat-web, just texts.
      4 
      5 Requirements
      6 ------------
      7 You need a markdown parser in your $PATH directory, for example install discount:
      8 
      9     pacman -S discount
     10     apt install discount
     11     dnf install discount
     12 
     13 Installation
     14 ------------
     15 Copy the script in your $PATH directory (if necessary as root):
     16     cp kaveh /usr/bin
     17 
     18 Usage
     19 -----
     20 
     21     kaveh
     22     kaveh -i [INPUT DIRECTORY] -o [OUTPUT DIRECTORY]
     23 
     24 If you don't want to set the methods, these are the defaults:
     25      [INPUT DIRECTORY] == empty, use $PWD/src
     26     [OUTPUT DIRECTORY] == empty, use $PWD/out
     27 
     28 Automation
     29 ----------
     30 Example of scripting to automate the process of file generation:
     31 
     32     kaveh -i /var/doc/mahdym.ir -o /var/www/mahdym.ir