diff --git a/README.md b/README.md index 86a56c7..be804e8 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ # GSL: Statique Littérateur -=== +------------------------------------------------------------------------ GSL is a multiple blogs/websites generator based on their domain, written in bash, for minimal dependancies. The websites are nearly all -static, except for some includes that nginx can easily get, in your -webserver. +static, except for some includes pages, like listing posts, that nginx +can easily get, in your webserver. # Dependancies -=== +------------------------------------------------------------------------ + - bash - coreutils - curl (to check Posts links response) # GSL: Installation -=== +------------------------------------------------------------------------ To avoid sudo, you should give permissions to USER @@ -45,7 +46,7 @@ To avoid sudo, you should give permissions to USER # How to configure a DOMAIN folder, and create a Post -=== +------------------------------------------------------------------------ ## Set a DOMAIN - add a DOMAIN name (if not alrady done) @@ -61,9 +62,10 @@ gsl help install ## Set a DOMAIN folder if not already done: -- Create or go into your folder of choice +- GSl will ask you to create a folder for your DOMAIN posts when adding a new domain +- Add/Create or go into your folder of choice - Save into that folder a blank file named gsl.DOMAIN (gsl.example.org) -to tell GSL, this folder is for this DOMAIN website +to tell GSL, this folder is for this DOMAIN website. ## Create a new Post - Write a post in a file, using some "metas" that GSL will catch. @@ -71,23 +73,28 @@ The engine is written from scratch and looks like a mix of markdown and ReStructuredText. It's very easy to learn and use. - Save your file with .gsl extension - Start checking it, using: + ``` gsl check ``` + If your Post has no error, you will have some ready to deploy html files and folders. You could install lightweight darkhttpd webserver on -your PC to preview the website +your PC to preview the website, or even, juste open index.html in your +server folder. # Create a Templates -=== +------------------------------------------------------------------------ + You will have to create some CSS in your /DOMAIN/templates/ - HOME: ~/.config/gsl/domains/DOMAIN/templates/ - GLOBAL: /var/lib/gsl/domains/DOMAIN/templates/ # How to Write a Post -=== -Post has 2 sections : Vefore and after #1. #1 is the FIRST Title of your -post. #(1-6) are HTML titles (

to

). +------------------------------------------------------------------------ + +Post has 2 sections : Before and after "#1". "#1" is the FIRST +Title of your post. Number (1-6) are HTML titles (h1 to h6). - Before #1 is used to set METAs HEADERS to configure your Post. - After #1 is the CONTENT of your Post diff --git a/var/lib/gsl/README.md b/var/lib/gsl/README.md index 86a56c7..be804e8 100644 --- a/var/lib/gsl/README.md +++ b/var/lib/gsl/README.md @@ -1,20 +1,21 @@ # GSL: Statique Littérateur -=== +------------------------------------------------------------------------ GSL is a multiple blogs/websites generator based on their domain, written in bash, for minimal dependancies. The websites are nearly all -static, except for some includes that nginx can easily get, in your -webserver. +static, except for some includes pages, like listing posts, that nginx +can easily get, in your webserver. # Dependancies -=== +------------------------------------------------------------------------ + - bash - coreutils - curl (to check Posts links response) # GSL: Installation -=== +------------------------------------------------------------------------ To avoid sudo, you should give permissions to USER @@ -45,7 +46,7 @@ To avoid sudo, you should give permissions to USER # How to configure a DOMAIN folder, and create a Post -=== +------------------------------------------------------------------------ ## Set a DOMAIN - add a DOMAIN name (if not alrady done) @@ -61,9 +62,10 @@ gsl help install ## Set a DOMAIN folder if not already done: -- Create or go into your folder of choice +- GSl will ask you to create a folder for your DOMAIN posts when adding a new domain +- Add/Create or go into your folder of choice - Save into that folder a blank file named gsl.DOMAIN (gsl.example.org) -to tell GSL, this folder is for this DOMAIN website +to tell GSL, this folder is for this DOMAIN website. ## Create a new Post - Write a post in a file, using some "metas" that GSL will catch. @@ -71,23 +73,28 @@ The engine is written from scratch and looks like a mix of markdown and ReStructuredText. It's very easy to learn and use. - Save your file with .gsl extension - Start checking it, using: + ``` gsl check ``` + If your Post has no error, you will have some ready to deploy html files and folders. You could install lightweight darkhttpd webserver on -your PC to preview the website +your PC to preview the website, or even, juste open index.html in your +server folder. # Create a Templates -=== +------------------------------------------------------------------------ + You will have to create some CSS in your /DOMAIN/templates/ - HOME: ~/.config/gsl/domains/DOMAIN/templates/ - GLOBAL: /var/lib/gsl/domains/DOMAIN/templates/ # How to Write a Post -=== -Post has 2 sections : Vefore and after #1. #1 is the FIRST Title of your -post. #(1-6) are HTML titles (

to

). +------------------------------------------------------------------------ + +Post has 2 sections : Before and after "#1". "#1" is the FIRST +Title of your post. Number (1-6) are HTML titles (h1 to h6). - Before #1 is used to set METAs HEADERS to configure your Post. - After #1 is the CONTENT of your Post diff --git a/var/lib/gsl/helps/gsl_help_install b/var/lib/gsl/helps/gsl_help_install index 546fc4a..3d7886c 100644 --- a/var/lib/gsl/helps/gsl_help_install +++ b/var/lib/gsl/helps/gsl_help_install @@ -1,4 +1,5 @@ # GSL: Installation +------------------------------------------------------------------------ To avoid sudo, you should give permissions to USER diff --git a/var/lib/gsl/helps/gsl_infos_new_website b/var/lib/gsl/helps/gsl_infos_new_website index fc443be..eb6a7df 100644 --- a/var/lib/gsl/helps/gsl_infos_new_website +++ b/var/lib/gsl/helps/gsl_infos_new_website @@ -14,6 +14,6 @@ : --prefix/DOMAIN/templates # Writing your Posts: - - Create or go into a folder (i.e. /home/USER/Documents/Mytexts) + - Add/Create or go into a folder (i.e. /home/USER/Documents/Mytexts) - Set an empty file in this folder named gsl.DOMAIN (i.e. gsl.example.com) - Save in this folder your posts in files with .gsl extension (i.e. mygreatpost.gsl)