This here is the base demo page for static site generator ssg.
55 |
56 |
The base page holds page entries to different articles in the same directory. Since this is a demo page, check out how to properly format base.md pages, index,md pages and general markdown pages in the following article entries.
95 |
96 |
97 |
110 |
111 |
112 |
113 |
114 |
115 |
--------------------------------------------------------------------------------
/Readme.md:
--------------------------------------------------------------------------------
1 | > [!IMPORTANT]
2 | > ***New repositories from now on will be uploaded to [github.com/samiulahmedjoy](https://github.com/samiulahmedjoy) If you have any issues regarding this repository, make sure to open issues here instead at [github.com/samiulahmedjoy/ssg](https://github.com/samiulahmedjoy/ssg)***
3 |
4 | # Here's a Video tutorial
5 |
6 | [](https://www.youtube.com/watch?v=W9qleSpFd20)
7 |
8 | # Static Site Generator in Shell Script
9 |
10 | 
11 |
12 |
A Demo page
13 |
14 | ## See site made with ssg -> [https://samiuljoy.github.io](https://samiuljoy.github.io)
15 |
16 | ## Intro
17 |
18 | A static site generator written in shell script. Write posts in markdown.md format with added features like basic tables and underlines.
19 |
20 | This is a minimalist site generator written from scratch. I've seen couple of git repos on static site generator being minimalist, where they pull bunch of dependencies, depends on third party libraries and what not.
21 |
22 | This is nothing like that. The only dependencies are Gnu versions of `grep`, `sed`, `awk` and `xargs` which are probably already installed in your system if you're on Gnu/Linux. If not, then you'll need gnu-coreutils.
23 |
24 | ## Stuff in this repo
25 |
26 | main.sh -> the main script file
27 |
28 | rss.awk -> awk script to arrange rss.xml feed by latest dates (this is in a separate file because -> taken from stack exchange)
29 |
30 | css directory -> has css styles
31 |
32 | js directory -> has 28 lines of js code for dark mode and light mode toggle
33 |
34 | demo -> a directory with some examples
35 |
36 | ### This 9 steps are basically tldr; Watch the video above for demo
37 |
38 | **Step1:** Generate a config file by running 'sh main.sh config'. Then edit the config.txt file on your own. For an example config file, you can see 'https://samiuljoy.github.io/config.txt'. Make sure to add a base.md page on your first entry to every new page except for about and index page. The need for base.md page is to hold records of the different posts and display them on a dedicated page. For more info about basepage syntax please refer to 'https://samiuljoy.github.io/demo/basepage.html'
39 |
40 | **Step2:** If you're done editing config.txt file, initialize everything that you've declared on your config file by running 'sh main.sh init'. This will create all the files, directories and whatnot
41 |
42 | **Step3:** Now, generate navigation section by running 'sh main.sh navgen'. This navigation part just adds home, roam and base buttons on your navigation section
43 |
44 | **Step4:** Now generate an index file with 'sh main.sh indexgen'
45 |
46 | **Step5:** Now Edit the base.md page if your article is going to be in a directory such as 'blog/firstblog.md'. In such case, first edit 'blog/base.md' page with your text editor. For an example see 'https://samiuljoy.github.io/microblog/base.md' and for syntax documentation, please refer to 'https://samiuljoy.github.io/demo/basepage.html'. Just run 'sh main.sh post' and when it asks for the filename, just add 'blog/base.md' as the filename
47 |
48 | **Step6:** If you've completed everything above correctly, you can start writing your posts. You can either run 'sh main.sh post' and add manual entries to config.txt, blog/base.md file or you could just run 'sh main.sh add' and let all your entries by added automatically. It's your choice, depends on use case hence, added both post and add option for for variance.
49 |
50 | **Step7:** Now since you've added all posts and everything, now run 'sh main.sh all'. This will generate html pages for all the files mentioned in 'config.txt'.
51 |
52 | **Step8:** For convenience you can also run 'sh main.sh final' which will copy all the generated html files into a separate sub-directory
53 |
54 | **Step9:** Last but not least, you can also generate rss.xml feeds of all your posts. Just run 'sh main.sh rss'"
55 |
56 | Done!
57 |
58 | **Note: Images and medias should be in assets directory**
59 |
60 | Visit [https://samiuljoy.github.io/demo/base.html](https://samiuljoy.github.io/demo/base.html) for detailed info.
61 |
--------------------------------------------------------------------------------
/demo/ssg.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | About ssg
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
37 |
38 |
39 |
40 | λ
41 |
42 |
50 |
51 |
52 |
Static Site Generator
53 |
54 |
What is ssg?
55 |
56 |
ssg is a static site generator written in shell script. This thing basically takes in files written in markdown format and converts them into proper html files that you can later deploy on your websites or your servers. All you need is a proper config.txt file and you are ready to go. This article does not elaborate on how to write and configure ssg or the config.txt file. Please see the github instructions for configuring and using ssg.
57 |
58 |
For reference you can see how this sites source code and all the files in it, and how they are arranged and how they work.
59 |
60 |
What is it used for?
61 |
62 |
For converting markown files into html files. Markdown files are easy to write compared to html ones as they require you to have tags and brackets and all sorts of things. Here, you write documents in clear and elegant markown format and ssg does the dirty work for you and converts the file into html.
63 |
64 |
Not only that, with a proper directory structure provided to a config file, you can arrange a whole website structure pretty easily and quickly.
65 |
66 |
Why should you use it?
67 |
68 |
Well, you can use it if;
69 |
70 |
71 |
You're converting a file from markown to html
72 |
you're deploying a website and want to create file structure automatically
73 |
if you dont love writing html syntax files and love markdown files
87 |
88 |
89 |
102 |
103 |
104 |
105 |
106 |
107 |
--------------------------------------------------------------------------------
/demo/indexpage.md:
--------------------------------------------------------------------------------
1 | +++++++++++++++++head
2 | .title: Learn how to edit index.md pages
3 | .author: samiuljoy
4 | .description: Learn how to write index.md pages with ssg
5 | .style: ..//css/maind.css
6 | .style: ..//css/main.css
7 | .name-generator: Index page edit
8 | .canonical-link: https://samiuljoy.github.io/demo/indexpage.html
9 | -------------------head
10 |
11 | ++++navigation
12 | .homepage: [home](..//index.html)
13 | .navmenu: roam
14 | .navpage: [demo](..//demo/base.html)
15 | .navpage: [microblog](..//microblog/base.html)
16 | .navpage: [theology](..//theology/base.html)
17 | .navpage: [academics](..//academics/base.html)
18 | .backpage: [base](base.html)
19 | ----------navigation
20 |
21 | ++++++++++++++++main
22 | .ce header1: Syntax Intro to index.md
23 |
24 | The index page needs to be edited manually means writing from scratch.
25 |
26 | Here's a sample demo page;
27 |
28 | ```1
29 | $ cat index.md
30 |
31 | ++++++++++++++++head
32 | .title: A blog by samiuljoy
33 | .author: samiuljoy
34 | .description: A demo page on ssg + random blog
35 | .style: css/imain.css
36 | .name-generator: A personal space of samiuljoy
37 | .canonical: https://samiuljoy.github.io/
38 | --------------------head
39 |
40 |
41 | ++++++++++++++++++++++intro
42 | .h2: samiuljoy.github.io
43 | .h2: Random stuff
44 | .img: 
45 | ----------------------intro
46 |
47 |
48 | ++++++++++++++++++++navigation
49 | .page: [demo](demo/base.html)
50 | .page: [about](about.html)
51 | .page: [blog](blog/base.html)
52 | -------------------------navigation
53 |
54 |
55 | +++++++++++++++++++footer
56 | .message:
57 | --------------------footer
58 |
59 |
60 | +++++++++++++++++++++script
61 | .script: js/itoggle.js
62 | ---------------------script
63 |
64 |
65 | ```
66 | .code1
67 |
68 |
69 | ## # Head section
70 |
71 | The ++head and --head section is the tags.
72 |
73 |
74 | __.title__ -> is the title tag
75 |
76 | __.author__ -> Your name
77 |
78 | __.description__ -> something to describe about the page
79 |
80 | __.style__ -> the index css. You can change it if you like.
81 |
82 | __.name-generator__ -> whatever you want to best describe the index page
83 |
84 | __.canonical__ -> the link to your site, in my case I would type in https://samiuljoy.github.io
85 |
86 | ## # Intro section
87 |
88 | Intro section ++intro --intro is what get's displayed on the screen.
89 |
90 | __.h2__ -> heading 2 texts
91 |
92 | __.img: !\[image alt\](assets/image.png)__ -> is what gets displayed at the image section. The image section is mostly in markdown syntax.
93 |
94 | ## # Navigation section
95 |
96 | These are the navigation pages. The words in square [square] brackets is what gets displayed and (dirname/base.html) is the link to the base.html file. Remember to only include base.html pages when mentioning directories.
97 |
98 | Bounded by ++navigation and --navigation and each page section starts with `.page:` followed by the display name and url
99 |
100 | ## # Footer section
101 |
102 | Bounded by ++footer and --footer the `.message: ` part is what get's displayed on the footer part
103 |
104 |
105 | ## # Script section
106 |
107 | This little script portion is for dark/light mode toggle. If you click the image, the page will be in dark mode and clicking again puts it in light mode. You can also add custom scripts the same way.
108 |
109 | This is what it should look like;
110 |
111 | ## # Generating index.md page
112 |
113 | For generating index.md pages from the shell you'd do
114 |
115 | ```no
116 | $ sh main.sh index index.md
117 | ```
118 | This will generate a index.html
119 |
120 | .hr
121 |
122 | ----------------main
123 |
124 | ++++++++++++++++footer
125 | .message: Made with <3 by [samiuljoy](https://github.com/samiuljoy)
126 | .message: [rss](/rss.xml) | [about](/about.html) | [go to top](#)
127 | ------------------footer
128 |
129 | +++++++script
130 | mode = document.getElementById('switch');
131 |
132 | if (! navigator.cookieEnabled) {
133 | mode.style.display = 'none';
134 | }
135 | else if(! localStorage) {
136 | mode.style.display = 'none';
137 | }
138 | else {
139 | mode.style.display = 'inline';
140 | }
141 | -----------------script
142 |
143 | +++++++++add
144 | .script: ..//js/toggle.js
145 | -----------add
146 |
147 |
--------------------------------------------------------------------------------
/demo/basepage.md:
--------------------------------------------------------------------------------
1 | +++++++++++++++++head
2 | .title: Learn how to edit base pages
3 | .author: samiuljoy
4 | .description: Learn how to edit base.md pages
5 | .style: ..//css/maind.css
6 | .style: ..//css/main.css
7 | .name-generator: Basepage Edit tutorial
8 | .canonical-link: https://samiuljoy.github.io/demo/basepage.html
9 | -------------------head
10 |
11 | ++++navigation
12 | .homepage: [home](..//index.html)
13 | .navmenu: roam
14 | .navpage: [demo](..//demo/base.html)
15 | .navpage: [microblog](..//microblog/base.html)
16 | .navpage: [theology](..//theology/base.html)
17 | .navpage: [academics](..//academics/base.html)
18 | .backpage: [base](base.html)
19 | ----------navigation
20 |
21 | ++++++++++++++++main
22 | .ce header1: Basepage Edit
23 |
24 | Learn how to edit base.md pages. base.md pages basically holds the article records along with some short introduction about this section of the webpage for the the articles under a topic. Editing base.md pages are very easy. If you've read the [syntax.html](syntax.html) article, all syntaxes are valid here as well, the only extra portions are the .date entries, the .article entries and the .describe entry.
25 |
26 | To edit a dir/base.md file, you could manually edit it by hand or run from your terminal;
27 |
28 | ```no
29 | $ sh main.sh post
30 |
31 | then when asked about filename: you put in dirname/base.md
32 | where dirname is any directory name and base.md is the base file
33 | ```
34 |
35 | Then fill all the values and edit base.md file like this;
36 |
37 |
38 | ```no
39 | .ce header1: some page name
40 |
41 | This is a base page for some articles, Here are some articles;
42 |
43 | ++++++++++++++++++++++++++++++++card
44 |
45 | .date: April 32, 2077
46 | .article: [Meeting the coolest person on the fediverse](cool.html)
47 | .describe: On this day the coolest person on the fediverse was born and I got to meet them!!
48 |
49 | .date: August 25, 2022
50 | .article: [how I learned to cook for the first time](cook.html)
51 | .describe: This article describes about my first experience with cooking
52 |
53 | .date: December 66, 4041
54 | .article: [How I almost smiled](smile.html)
55 | .describe: This article describes how I almost smiled
56 |
57 | -----------------card
58 |
59 | ```
60 |
61 | There's 3 articles mentioned here. Each of these articles has a .date, and .article and a .describe section seperated by a blank line bounded by a ++++card and ----card section.
62 |
63 |
64 | The ++card --card section is what identifies this section as a article section.
65 |
66 |
67 | ```no
68 | .ce header1: some page name
69 |
70 | This is a base page for some articles. Here are some articles;
71 |
72 | ++++++++++++++++++++card
73 |
74 | --------------------card
75 |
76 |
77 | ```
78 |
79 | Then add first article in card section.
80 |
81 | ```no
82 | .ce header1: some page name
83 |
84 | This is a base page for some articles. Here are some articles;
85 |
86 | ++++++++++++++++++++card
87 |
88 | .date: April 32, 2077
89 | .article: [Meeting the coolest person on the fediverse](cool.html)
90 | .describe: On this day the coolest person on the fediverse was born and I got to meet them!!
91 |
92 | -------------------card
93 |
94 | ```
95 |
96 | ___.date section:___ The date section starts with .date and a colon(:) making .date: The date content should be in `Month date, year` which is `April 32, 2077`. Notice the space in between.
97 |
98 | ___.article section:___ The article section starts the same way date does. The text the square brackets [text in square brackets] is the title. which gets displayed as a title and the text in (link.html) is the page it goes to. Much like normal url links in markdown format.
99 |
100 | ___.describe section:___ The describe section is the text which gets displayed in the description section of the card section.
101 |
102 | That's how you add articles. Then to add another article, just add a blank line after .describe: and start from .date ^\_^
103 |
104 | You can also add next page href link to basepages;
105 |
106 | ```no
107 | .next[next->](base2.html)
108 | ```
109 |
110 | .hr
111 | ----------------main
112 |
113 | ++++++++++++++++footer
114 | .message: Made with <3 by [samiuljoy](https://github.com/samiuljoy)
115 | .message: [rss](/rss.xml) | [about](/about.html) | [go to top](#)
116 | ------------------footer
117 |
118 | +++++++script
119 | mode = document.getElementById('switch');
120 |
121 | if (! navigator.cookieEnabled) {
122 | mode.style.display = 'none';
123 | }
124 | else if(! localStorage) {
125 | mode.style.display = 'none';
126 | }
127 | else {
128 | mode.style.display = 'inline';
129 | }
130 | -----------------script
131 |
132 | +++++++++add
133 | .script: ..//js/toggle.js
134 | -----------add
135 |
136 |
--------------------------------------------------------------------------------
/demo/indexpage.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Learn how to edit index.md pages
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
37 |
38 |
39 |
40 | λ
41 |
42 |
50 |
51 |
52 |
Syntax Intro to index.md
53 |
54 |
The index page needs to be edited manually means writing from scratch.
The ++head and --head section is the <head></head> tags.
104 |
105 |
106 |
.title -> is the title tag <title>
107 |
108 |
.author -> Your name
109 |
110 |
.description -> something to describe about the page
111 |
112 |
.style -> the index css. You can change it if you like.
113 |
114 |
.name-generator -> whatever you want to best describe the index page
115 |
116 |
.canonical -> the link to your site, in my case I would type in https://samiuljoy.github.io
117 |
118 |
# Intro section
119 |
120 |
Intro section ++intro --intro is what get's displayed on the screen.
121 |
122 |
.h2 -> heading 2 texts
123 |
124 |
.img:  -> is what gets displayed at the image section. The image section is mostly in markdown syntax.
125 |
126 |
# Navigation section
127 |
128 |
These are the navigation pages. The words in square [square] brackets is what gets displayed and (dirname/base.html) is the link to the base.html file. Remember to only include base.html pages when mentioning directories.
129 |
130 |
Bounded by ++navigation and --navigation and each page section starts with .page: followed by the display name and url
131 |
132 |
# Footer section
133 |
134 |
Bounded by ++footer and --footer the .message: part is what get's displayed on the footer part
135 |
136 |
137 |
# Script section
138 |
139 |
This little script portion is for dark/light mode toggle. If you click the image, the page will be in dark mode and clicking again puts it in light mode. You can also add custom scripts the same way.
140 |
141 |
This is what it should look like;
142 |
143 |
# Generating index.md page
144 |
145 |
For generating index.md pages from the shell you'd do
146 |
147 |
148 |
149 | $ sh main.sh index index.md
150 |
151 |
Learn how to edit base.md pages. base.md pages basically holds the article records along with some short introduction about this section of the webpage for the the articles under a topic. Editing base.md pages are very easy. If you've read the syntax.html article, all syntaxes are valid here as well, the only extra portions are the .date entries, the .article entries and the .describe entry.
55 |
56 |
To edit a dir/base.md file, you could manually edit it by hand or run from your terminal;
57 |
58 |
59 |
60 | $ sh main.sh post
61 |
62 | then when asked about filename: you put in dirname/base.md
63 | where dirname is any directory name and base.md is the base file
64 |
65 |
66 |
67 |
Then fill all the values and edit base.md file like this;
68 |
69 |
70 |
71 |
72 | .ce header1: some page name
73 |
74 | This is a base page for some articles, Here are some articles;
75 |
76 | ++++++++++++++++++++++++++++++++card
77 |
78 | .date: April 32, 2077
79 | .article: [Meeting the coolest person on the fediverse](cool.html)
80 | .describe: On this day the coolest person on the fediverse was born and I got to meet them!!
81 |
82 | .date: August 25, 2022
83 | .article: [how I learned to cook for the first time](cook.html)
84 | .describe: This article describes about my first experience with cooking
85 |
86 | .date: December 66, 4041
87 | .article: [How I almost smiled](smile.html)
88 | .describe: This article describes how I almost smiled
89 |
90 | -----------------card
91 |
92 |
93 |
94 |
95 |
There's 3 articles mentioned here. Each of these articles has a .date, and .article and a .describe section seperated by a blank line bounded by a ++++card and ----card section.
96 |
97 |
98 |
The ++card --card section is what identifies this section as a article section.
99 |
100 |
101 |
102 |
103 | .ce header1: some page name
104 |
105 | This is a base page for some articles. Here are some articles;
106 |
107 | ++++++++++++++++++++card
108 |
109 | --------------------card
110 |
111 |
112 |
113 |
114 |
115 |
Then add first article in card section.
116 |
117 |
118 |
119 | .ce header1: some page name
120 |
121 | This is a base page for some articles. Here are some articles;
122 |
123 | ++++++++++++++++++++card
124 |
125 | .date: April 32, 2077
126 | .article: [Meeting the coolest person on the fediverse](cool.html)
127 | .describe: On this day the coolest person on the fediverse was born and I got to meet them!!
128 |
129 | -------------------card
130 |
131 |
132 |
133 |
134 |
.date section: The date section starts with .date and a colon(:) making .date: The date content should be in Month date, year which is April 32, 2077. Notice the space in between.
135 |
136 |
.article section: The article section starts the same way date does. The text the square brackets [text in square brackets] is the title. which gets displayed as a title and the text in (link.html) is the page it goes to. Much like normal url links in markdown format.
137 |
138 |
.describe section: The describe section is the text which gets displayed in the description section of the card section.
139 |
140 |
That's how you add articles. Then to add another article, just add a blank line after .describe: and start from .date ^_^
141 |
142 |
You can also add next page href link to basepages;
` paragraph tags.
42 |
43 | ## # General header tags
44 |
45 | General headers starts with # followed by header numbers. The header above that says '# General header tags' is a header2 writen like this;
46 |
47 | ```no
48 | ## # General header tags
49 | ```
50 |
51 | Also normal headers as well;
52 |
53 | # This is header 1
54 | ## This is header 2
55 | ### This is header 3
56 | #### This is header 4
57 |
58 | which is;
59 |
60 | ```no
61 | # This is header 1
62 | ## This is header 2
63 | ### This is header 3
64 | #### This is header 4
65 | ```
66 |
67 | ## # Bold texts
68 |
69 | Bold tags follows basic markdown syntax, **this is a bold text** with double asterisks and __this__ with double underscores which should look like this in raw mode;
70 |
71 | ```no
72 | **this is a bold text** with double asterisks and __this__ with double underscores
73 | ```
74 |
75 | __Note:__ If you're starting some line with bold or italic or bold-italic or urls then consider using underscores for bold,italic or bold-italics instead of asterisks and for urls use an extra space at the very begining.
76 |
77 | ## # Italic texts
78 |
79 | Italic texts with one asterisk \* or one underscore \_. This text is _italic_ and this is also *italic* which in markdown format looks like this;
80 |
81 | ```no
82 | This text is _italic_ and this is also *italic*
83 | ```
84 |
85 | ## # Bold-Italic texts
86 |
87 | Bold-italic texts with three asterisks \*\*\* or three underscores \_\_\_. This text is ___bold italic___ and this is also ***bold italic***
88 |
89 | ```no
90 | This text is ___bold italic___ and this is also ***bold italic***
91 | ```
92 |
93 | ## {id="underline"} # Underline texts
94 |
95 | Markdown syntax does not come with any underline features, so this is how you do ,,,underlines,,, for now, with three commas `,,,`
96 |
97 | ```no
98 | this is how you do ,,,underlines,,, for now
99 | ```
100 |
101 | ## # Strike Through texts
102 |
103 | This text is a ~~strike~~ through ~~text~~
104 |
105 | ```no
106 | This text is a ~~strike~~ through ~~text~~
107 | ```
108 |
109 | ## # URL texts
110 |
111 | Follows default markdown syntax.
112 |
113 | [This](https://example.org) is a url that leads to example.org and [this](https://duckduckgo.com) to duckduckgo.com
114 |
115 | ```no
116 | [This](https://example.org) is a url that leads to example.org and [this](https://duckduckgo.com) to duckduckgo.com
117 | ```
118 |
119 | You can also jump through sections with `{id="idname"}` after a header section and mentioning the idname in url section with \[url link name\](#idname)
120 |
121 | ```no
122 | This is a text and this is a [url](#another) which will jump to another section of the article.
123 | This is some text and some more text
124 | Again some text. Next portion is
125 |
126 | ### {id="another"} # Some header text
127 |
128 | some more text
129 | ```
130 |
131 | ## # Image add
132 |
133 | Add paragraph images with `.pimg:` tags
134 |
135 | ```no
136 | .pimg: ../assets/terry.png terry davis quote
137 |
138 | .caption: Image: One of Terry Davis's quotes
139 | ```
140 |
141 | The .pimg portion is calling paragraph image method, then terry.png is the image file being called from previous directory assets and the later portion is just an alt, if image does not get displayed then show 'terry davis quote'. The caption portion is what get's displayed below the image.
142 |
143 | .pimg: ../assets/terry.png terry davis quote
144 |
145 | .caption: Image: One of Terry Davis's quotes
146 |
147 | Alternatively you can also add class sections in images. The cover image(which is previously mentioned in css file) at the top looks like this in raw code;
148 |
149 | ```no
150 | .img: class="cover" ../assets/terry.png A famous quote from Terry Davis
151 | ```
152 |
153 | __Explanation:__ The `.img` method invokes class="cover" followed by the image file directory which is `../assets/terry.png`. The later portion is for accessibility which is an alt text. The spaces are separators in this case.
154 |
155 | And yes you can also use default markdown syntax to add images as well;
156 |
157 | ```no
158 | 
159 | .caption: Image: One of Terry Davis's quotes
160 | ```
161 |
162 | 
163 |
164 | .caption: Image: One of Terry Davis's quotes
165 |
166 | ## # Video addition
167 |
168 | The video addition tag is pretty simple, follows a markdown alike syntax;
169 |
170 | ```no
171 | !
172 | .caption: video: keynav and xmouseless
173 | ```
174 |
175 | !
176 |
177 | .caption: video: keynav and xmouseless
178 |
179 | ## # Blockquotes
180 |
181 | Blockquotes also follows markdown syntax but each `>` expands to a new-line;
182 |
183 | ```no
184 |
185 | > This is a text in a blockquote
186 | > This is another line of text in a blockquote
187 |
188 | ```
189 |
190 | __Notice the extra one blank line above and one blank line below. This blank lines are necesary for blockquotes, also looks good too__
191 |
192 | > This is a text in a blockquote
193 | > This is another line of text in a blockquote
194 |
195 |
196 | ## # Unordered lists
197 |
198 | Like you'd do in a markdown file;
199 |
200 | ```no
201 |
202 | * This is an item in an unordered list
203 | * Another item
204 | * And another item
205 |
206 | ```
207 | __Notice the blank lines above and below__
208 |
209 | * This is an item in an unordered list
210 | * Another item
211 | * And another item
212 |
213 | You can also use dash - instead of asterisks
214 |
215 | ```no
216 |
217 | - This is an item in an unordered list
218 | - Another item
219 | - And another item
220 |
221 | ```
222 | Alternatively you can also use '#.' symbols instead of bullet points followed by a full-stop
223 |
224 | ```no
225 |
226 | #. This is an item in an unordered list
227 | #. Another item
228 | #. And another item
229 |
230 | ```
231 |
232 | #. This is an item in an unordered list
233 | #. Another item
234 | #. And another item
235 |
236 | ## # Ordered lists
237 |
238 | Also follows normal markdown syntax.
239 |
240 | ```no
241 |
242 | 1. Item 1 in ordered list
243 | 2. Item 2 in ordered list
244 | 3. Item 3 in ordered list
245 |
246 | ```
247 |
248 | 1. Item 1 in ordered list
249 | 2. Item 2 in ordered list
250 | 3. Item 3 in ordered list
251 |
252 | Alternatively you can also use alphabets;
253 |
254 | ```no
255 |
256 | a. Item 1 in ordered list
257 | b. Item 2 in ordered list
258 | c. Item 3 in ordered list
259 |
260 | ```
261 |
262 | Which eventually transforms into numbers, unfortunately, ordered list doesn't respect alphabetical orders in html.
263 |
264 | ## # Inline codes
265 |
266 | You've noticed me typing inline `tags` like this. Here's how to do it;
267 |
268 | ```no
269 | The text \`code\` will be an inline code
270 | ```
271 |
272 | The text `code` will be an inline code
273 |
274 | If you want literal backticks just do escapes
275 |
276 | ```no
277 | The text \\`code\\` will have literal backticks
278 | ```
279 |
280 | The text \`code\` will have literal backticks
281 |
282 | ## {id="table"} # Table addition
283 |
284 | Tables are very easy to add. `.th: ` is for table header, `.td: ` is for table data. Here's how you add tables;
285 |
286 | ```no
287 |
288 | +++++++++++++++++table
289 |
290 | .th: header 1
291 | .th: header 2
292 | .th: header 3
293 | .th: header 4
294 | .th: header 5
295 |
296 | .td: data 1
297 | .td: data 2
298 | .td: data 3
299 | .td: data 4
300 | .td: data 5
301 |
302 | .td: data 6
303 | .td: data 7
304 | .td: data 8
305 | .td: data 10
306 | .td: data 11
307 |
308 | .td: data 10
309 | .td: data 11
310 | .td: data 12
311 | .td: data 13
312 | .td: data 14
313 |
314 | .td: data 15
315 | .td: data 16
316 | .td: data 17
317 | .td: data 18
318 | .td: data 19
319 |
320 | ----------------table
321 |
322 | .caption: Table: A Demo Table
323 |
324 | ```
325 |
326 | __Notice the blank line before .th on line 1 and a blank line after the last .td: data 14. Blanks are important__
327 |
328 | ++++++++++table
329 |
330 | .th: header 1
331 | .th: header 2
332 | .th: header 3
333 | .th: header 4
334 | .th: header 5
335 |
336 | .td: data 1
337 | .td: data 2
338 | .td: data 3
339 | .td: data 4
340 | .td: data 5
341 |
342 | .td: data 6
343 | .td: data 7
344 | .td: data 8
345 | .td: data 10
346 | .td: data 11
347 |
348 | .td: data 10
349 | .td: data 11
350 | .td: data 12
351 | .td: data 13
352 | .td: data 14
353 |
354 | .td: data 15
355 | .td: data 16
356 | .td: data 17
357 | .td: data 18
358 | .td: data 19
359 |
360 | ----------------table
361 |
362 |
363 | .caption: Table: A Demo Table
364 |
365 |
366 | ## # Add Month date, year
367 |
368 | If you invoke `[ .today ]`,(with nospaces) this will add today's date like this;
369 |
370 | Today is October 10, 2021, the day seems nice, and I'm feeling good today
371 |
372 | ```no
373 | Today is [.today], The day seems nice and all, and I'm feeling good today
374 | ```
375 |
376 | ## Add a next page url
377 |
378 | You can also add next page href link to basepages;
379 |
380 | ```no
381 | .next[next->](base2.html)
382 | ```
383 |
384 | ## # Code block section
385 |
386 | Code block section is mostly similar to the default markdown syntaxes with some changes/added features. This is how you do code blocks;
387 |
388 | ```no
389 | #!/usr/bin/env sh
390 | echo "hello world"
391 | ```
392 |
393 | The portion above is a code block, which when writing should be written like this;
394 |
395 | ```no
396 | \`\`\`no
397 | #!/usr/bin/env sh
398 | echo "hello world"
399 | \`\`\`
400 | ```
401 |
402 | /* the backslashes are escapes */
403 |
404 | Every code block section should have an extra tab in front of each line. Notice the extra tabs before each line within backticks. The tabs gets rearranged into their original form when viewed from the web browser. The `no` portion means this is code section does not need to viewed as raw. Viewing in raw mode is similar to copying texts, but with view raw mode, you can curl or wget only the code portion instead of downloading the whole source code for the website then deleting all extra codes later. That's a pain.
405 |
406 | This is what it looks like with view raw mode;
407 |
408 | ```1
409 | #!/usr/bin/env sh
410 | echo "hello world"
411 | ```
412 | .code1
413 |
414 | This is what you'd actually type in;
415 |
416 | ```no
417 | \`\`\`1
418 | #!/usr/bin/env sh
419 | echo "hello world"
420 | \`\`\`
421 | .code1
422 | ```
423 |
424 | The view raw text method uses serial number based code block arrangement in a separate directory assigned for raw code sections. The 1 after 3 backticks means it's the first code that needs to have a view raw section and the `.code1` later get's transformed into "view raw". The serial number should be same for 1 and .code1. Then for a second code block with view raw option you'd do 2 and the .code2 like this;
425 |
426 | ```2
427 | #!/usr/bin/env sh
428 | echo "this is a second code block"
429 | ```
430 | .code2
431 |
432 | This would look something like this when writing;
433 |
434 | ```no
435 | \`\`\`2
436 | #!/usr/bin/env sh
437 | echo "this is a second code block"
438 | \`\`\`
439 | .code2
440 | ```
441 |
442 | So, no after 3 backticks means just normal code block section, no view raw code, and a numerical digit means it's supposed to be viewed as raw. Now from now on if I wanted to add another view raw code block section, I'd do 3 backticks and the add 3 to it and then add `.code3` after code block section.
443 |
444 | **Note: Don't break the serial number however, if you mentioned code block with 1 then assign the next one with 3, this wouldn't work properly**
445 |
446 | ## # Horizontal line
447 |
448 | I made a customized horizontal line, just invoke `.hr`
449 |
450 | ```no
451 | .hr
452 | ```
453 | This should print out a horizontal line like below;
454 |
455 | .hr
456 |
457 | ## # Line breaks
458 |
459 | Do line breaks with `.br`
460 |
461 | ```no
462 | This is a text
463 | .br
464 | This is another line of text but on a new line
465 | ```
466 |
467 | ## # Comments
468 |
469 | Comments are more like c11 style, this is how you do comments;
470 |
471 | ```no
472 | This is some text /* this is a comment */
473 | This is another line of text
474 | ```
475 |
476 | From the command line, you can also enable or disable comments;
477 |
478 | ```no
479 | $ sh main.sh html -c file.md
480 | ```
481 |
482 | Comments are removed by default when no flags are mentioned.
483 |
484 | ## # Nested blockquotes (experimental)
485 |
486 | You can also do nested blockquotes but they are still experimental. Here's how you do nested blockquotes;
487 |
488 | ```no
489 | > This is some text in blockquotes
490 | > Another line of text in a blockquote
491 | >> This portion is in nested blockquotes
492 | >> This portion is also in a nested blockquote on a new line
493 | > This text is in normal blockquotes
494 | ```
495 |
496 | > This is some text in blockquotes
497 | > Another line of text in a blockquote
498 | >> This portion is in nested blockquotes
499 | >> This portion is also in a nested blockquote but on a new line
500 | > This text is in normal blockquotes
501 |
502 |
503 | ## # Escape characters
504 |
505 | You've noticed that underscores \_ and \* asterisks are used as tag syntaxes. Well you can use literal underscores and asterisk with backslashes `\ _` without any spaces in between them;
506 |
507 | ```no
508 | This is \_ underscore and \* is an asterisk and \\` this is a backtick
509 | ```
510 |
511 | __Will print out;__
512 |
513 | This is \_ underscore and \* is an asterisk and \` this is a backtick
514 |
515 | If you want to use literal \\_ just use double backslashes;
516 |
517 | ```no
518 | This is \\_ underscore and \\* is an asterisk and \\\` this is a backtick
519 | ```
520 |
521 | __Will print out;__
522 |
523 | This is \\_ underscore and \\* is an asterisk and \\` this is a backtick
524 |
525 | That's it for basic syntax. Learn how to write base.md files on the [next](basepage.html) article or learn how to write index.md pages [here](indexpage.html). Check the source code for this site over [here](https://gitbub.com/samiuljoy/samiuljoy.github.io)
526 |
527 | .hr
528 |
529 | ----------------main
530 |
531 | ++++++++++++++++footer
532 | .message: Made with <3 by [samiuljoy](https://github.com/samiuljoy)
533 | .message: [rss](/rss.xml) | [about](/about.html) | [go to top](#)
534 | ------------------footer
535 |
536 | ++++++script
537 | mode = document.getElementById('switch');
538 |
539 | if (! navigator.cookieEnabled) {
540 | mode.style.display = 'none';
541 | }
542 | else if(! localStorage) {
543 | mode.style.display = 'none';
544 | }
545 | else {
546 | mode.style.display = 'inline';
547 | }
548 | -----------------script
549 |
550 | +++++++++add
551 | .script: ..//js/toggle.js
552 | -----------add
553 |
554 |
--------------------------------------------------------------------------------
/demo/syntax.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
Alright syntax 101 for ssg! Syntax for ssg is pretty simple. Dead simple. Most of it is basic markdown syntax with some additional features like inserting a table or underlines since markdown syntax doesn't support these features(yet). You can check the source code for this page in clear markdown format here.
60 |
61 |
See that heading at top that says 'Intro to syntax'? Notice the header is in center of the page and it's a header 1. Here's how you can add a center header1 tag;
Whatever after the colon(:) gets displayed on the main screen. Same way, you can add header2, header3 upto header4. Just add 1 or 2 or 3 or 4 after header and before :
70 |
71 |
72 |
# Paragraphs
73 |
74 |
To add a new paragraph, just start typing anything after a new line just like you would do in markdown files. Here every newline gets wraped around <p> paragraph tags.
75 |
76 |
# General header tags
77 |
78 |
General headers starts with # followed by header numbers. The header above that says '# General header tags' is a header2 writen like this;
96 |
97 | # This is header 1
98 | ## This is header 2
99 | ### This is header 3
100 | #### This is header 4
101 |
102 |
103 |
104 |
# Bold texts
105 |
106 |
Bold tags follows basic markdown syntax, this is a bold text with double asterisks and this with double underscores which should look like this in raw mode;
107 |
108 |
109 |
110 | **this is a bold text** with double asterisks and __this__ with double underscores
111 |
112 |
113 |
114 |
Note: If you're starting some line with bold or italic or bold-italic or urls then consider using underscores for bold,italic or bold-italics instead of asterisks and for urls use an extra space at the very begining.
115 |
116 |
# Italic texts
117 |
118 |
Italic texts with one asterisk * or one underscore _. This text is italic and this is also italic which in markdown format looks like this;
119 |
120 |
121 |
122 | This text is _italic_ and this is also *italic*
123 |
124 |
125 |
126 |
# Bold-Italic texts
127 |
128 |
Bold-italic texts with three asterisks *** or three underscores ___. This text is bold italic and this is also bold italic
129 |
130 |
131 |
132 | This text is ___bold italic___ and this is also ***bold italic***
133 |
134 |
135 |
136 |
# Underline texts
137 |
138 |
Markdown syntax does not come with any underline features, so this is how you do underlines for now, with three commas ,,,
139 |
140 |
141 |
142 | this is how you do ,,,underlines,,, for now
143 |
144 |
145 |
146 |
# Strike Through texts
147 |
148 |
This text is a strike through text
149 |
150 |
151 |
152 | This text is a ∼∼strike∼∼ through ∼∼text∼∼
153 |
154 |
155 |
156 |
# URL texts
157 |
158 |
Follows default markdown syntax.
159 |
160 |
This is a url that leads to example.org and this to duckduckgo.com
161 |
162 |
163 |
164 | [This](https://example.org) is a url that leads to example.org and [this](https://duckduckgo.com) to duckduckgo.com
165 |
166 |
167 |
168 |
You can also jump through sections with {id="idname"} after a header section and mentioning the idname in url section with [url link name](#idname)
169 |
170 |
171 |
172 | This is a text and this is a [url](#another) which will jump to another section of the article.
173 | This is some text and some more text
174 | Again some text. Next portion is
175 |
176 | ### {id="another"} # Some header text
177 |
178 | some more text
179 |
180 |
181 |
182 |
# Image add
183 |
184 |
Add paragraph images with .pimg: tags
185 |
186 |
187 |
188 | .pimg: ../assets/terry.png terry davis quote
189 |
190 | .caption: Image: One of Terry Davis's quotes
191 |
192 |
193 |
194 |
The .pimg portion is calling paragraph image method, then terry.png is the image file being called from previous directory assets and the later portion is just an alt, if image does not get displayed then show 'terry davis quote'. The caption portion is what get's displayed below the image.
195 |
196 |
197 |
198 |
199 |
Image: One of Terry Davis's quotes
200 |
201 |
Alternatively you can also add class sections in images. The cover image(which is previously mentioned in css file) at the top looks like this in raw code;
202 |
203 |
204 |
205 | .img: class="cover" ../assets/terry.png A famous quote from Terry Davis
206 |
207 |
208 |
209 |
Explanation: The .img method invokes class="cover" followed by the image file directory which is ../assets/terry.png. The later portion is for accessibility which is an alt text. The spaces are separators in this case.
210 |
211 |
And yes you can also use default markdown syntax to add images as well;
212 |
213 |
214 |
215 | 
216 | .caption: Image: One of Terry Davis's quotes
217 |
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
Image: One of Terry Davis's quotes
226 |
227 |
# Video addition
228 |
229 |
The video addition tag is pretty simple, follows a markdown alike syntax;
230 |
231 |
232 |
233 | !
234 | .caption: video: keynav and xmouseless
235 |
236 |
237 |
238 |
239 |
242 |
243 |
244 |
245 |
video: keynav and xmouseless
246 |
247 |
# Blockquotes
248 |
249 |
Blockquotes also follows markdown syntax but each > expands to a new-line;
250 |
251 |
252 |
253 |
254 | > This is a text in a blockquote
255 | > This is another line of text in a blockquote
256 |
257 |
258 |
259 |
260 |
Notice the extra one blank line above and one blank line below. This blank lines are necesary for blockquotes, also looks good too
261 |
262 |
263 |
This is a text in a blockquote
264 |
This is another line of text in a blockquote
265 |
266 |
267 |
268 |
# Unordered lists
269 |
270 |
Like you'd do in a markdown file;
271 |
272 |
273 |
274 |
275 | * This is an item in an unordered list
276 | * Another item
277 | * And another item
278 |
279 |
280 |
281 |
Notice the blank lines above and below
282 |
283 |
284 |
This is an item in an unordered list
285 |
Another item
286 |
And another item
287 |
288 |
289 |
You can also use dash - instead of asterisks
290 |
291 |
292 |
293 |
294 | - This is an item in an unordered list
295 | - Another item
296 | - And another item
297 |
298 |
299 |
300 |
Alternatively you can also use '#.' symbols instead of bullet points followed by a full-stop
301 |
302 |
303 |
304 |
305 | #. This is an item in an unordered list
306 | #. Another item
307 | #. And another item
308 |
309 |
310 |
311 |
312 |
313 |
This is an item in an unordered list
314 |
Another item
315 |
And another item
316 |
317 |
318 |
# Ordered lists
319 |
320 |
Also follows normal markdown syntax.
321 |
322 |
323 |
324 |
325 | 1. Item 1 in ordered list
326 | 2. Item 2 in ordered list
327 | 3. Item 3 in ordered list
328 |
329 |
330 |
331 |
332 |
333 |
Item 1 in ordered list
334 |
Item 2 in ordered list
335 |
Item 3 in ordered list
336 |
337 |
338 |
Alternatively you can also use alphabets;
339 |
340 |
341 |
342 |
343 | a. Item 1 in ordered list
344 | b. Item 2 in ordered list
345 | c. Item 3 in ordered list
346 |
347 |
348 |
349 |
350 |
Which eventually transforms into numbers, unfortunately, ordered list doesn't respect alphabetical orders in html.
351 |
352 |
# Inline codes
353 |
354 |
You've noticed me typing inline tags like this. Here's how to do it;
355 |
356 |
357 |
358 | The text `code` will be an inline code
359 |
360 |
361 |
362 |
The text code will be an inline code
363 |
364 |
If you want literal backticks just do escapes
365 |
366 |
367 |
368 | The text \`code\` will have literal backticks
369 |
370 |
371 |
372 |
The text `code` will have literal backticks
373 |
374 |
# Table addition
375 |
376 |
Tables are very easy to add. .th: is for table header, .td: is for table data. Here's how you add tables;
377 |
378 |
379 |
380 |
381 | +++++++++++++++++table
382 |
383 | .th: header 1
384 | .th: header 2
385 | .th: header 3
386 | .th: header 4
387 | .th: header 5
388 |
389 | .td: data 1
390 | .td: data 2
391 | .td: data 3
392 | .td: data 4
393 | .td: data 5
394 |
395 | .td: data 6
396 | .td: data 7
397 | .td: data 8
398 | .td: data 10
399 | .td: data 11
400 |
401 | .td: data 10
402 | .td: data 11
403 | .td: data 12
404 | .td: data 13
405 | .td: data 14
406 |
407 | .td: data 15
408 | .td: data 16
409 | .td: data 17
410 | .td: data 18
411 | .td: data 19
412 |
413 | ----------------table
414 |
415 | .caption: Table: A Demo Table
416 |
417 |
418 |
419 |
420 |
Notice the blank line before .th on line 1 and a blank line after the last .td: data 14. Blanks are important
421 |
422 |
423 |
424 |
425 |
426 |
header 1
427 |
header 2
428 |
header 3
429 |
header 4
430 |
header 5
431 |
432 |
433 |
434 |
data 1
435 |
data 2
436 |
data 3
437 |
data 4
438 |
data 5
439 |
440 |
441 |
442 |
data 6
443 |
data 7
444 |
data 8
445 |
data 10
446 |
data 11
447 |
448 |
449 |
450 |
data 10
451 |
data 11
452 |
data 12
453 |
data 13
454 |
data 14
455 |
456 |
457 |
458 |
data 15
459 |
data 16
460 |
data 17
461 |
data 18
462 |
data 19
463 |
464 |
465 |
466 |
467 |
468 |
469 |
470 |
471 |
Table: A Demo Table
472 |
473 |
474 |
# Add Month date, year
475 |
476 |
If you invoke [ .today ],(with nospaces) this will add today's date like this;
477 |
478 |
Today is October 10, 2021, the day seems nice, and I'm feeling good today
479 |
480 |
481 |
482 | Today is [.today], The day seems nice and all, and I'm feeling good today
483 |
484 |
485 |
486 |
Add a next page url
487 |
488 |
You can also add next page href link to basepages;
Every code block section should have an extra tab in front of each line. Notice the extra tabs before each line within backticks. The tabs gets rearranged into their original form when viewed from the web browser. The no portion means this is code section does not need to viewed as raw. Viewing in raw mode is similar to copying texts, but with view raw mode, you can curl or wget only the code portion instead of downloading the whole source code for the website then deleting all extra codes later. That's a pain.
The view raw text method uses serial number based code block arrangement in a separate directory assigned for raw code sections. The 1 after 3 backticks means it's the first code that needs to have a view raw section and the .code1 later get's transformed into "view raw". The serial number should be same for 1 and .code1. Then for a second code block with view raw option you'd do 2 and the .code2 like this;
544 |
545 |
546 |
547 | #!/usr/bin/env sh
548 | echo "this is a second code block"
549 |
550 |
556 |
557 | ```2
558 | #!/usr/bin/env sh
559 | echo "this is a second code block"
560 | ```
561 | .code2
562 |
563 |
564 |
565 |
So, no after 3 backticks means just normal code block section, no view raw code, and a numerical digit means it's supposed to be viewed as raw. Now from now on if I wanted to add another view raw code block section, I'd do 3 backticks and the add 3 to it and then add .code3 after code block section.
566 |
567 |
Note: Don't break the serial number however, if you mentioned code block with 1 then assign the next one with 3, this wouldn't work properly
568 |
569 |
# Horizontal line
570 |
571 |
I made a customized horizontal line, just invoke .hr
572 |
573 |
574 |
575 | .hr
576 |
577 |
578 |
This should print out a horizontal line like below;
579 |
580 |
581 |
582 |
# Line breaks
583 |
584 |
Do line breaks with .br
585 |
586 |
587 |
588 | This is a text
589 | .br
590 | This is another line of text but on a new line
591 |
592 |
593 |
594 |
# Comments
595 |
596 |
Comments are more like c11 style, this is how you do comments;
597 |
598 |
599 |
600 | This is some text /* this is a comment */
601 | This is another line of text
602 |
603 |
604 |
605 |
From the command line, you can also enable or disable comments;
606 |
607 |
608 |
609 | $ sh main.sh html -c file.md
610 |
611 |
612 |
613 |
Comments are removed by default when no flags are mentioned.
614 |
615 |
# Nested blockquotes (experimental)
616 |
617 |
You can also do nested blockquotes but they are still experimental. Here's how you do nested blockquotes;
618 |
619 |
620 |
621 | > This is some text in blockquotes
622 | > Another line of text in a blockquote
623 | >> This portion is in nested blockquotes
624 | >> This portion is also in a nested blockquote on a new line
625 | > This text is in normal blockquotes
626 |
627 |
628 |
629 |
630 |
This is some text in blockquotes
631 |
Another line of text in a blockquote
632 |
633 |
This portion is in nested blockquotes
634 |
635 |
636 |
This portion is also in a nested blockquote but on a new line
637 |
638 |
This text is in normal blockquotes
639 |
640 |
641 |
642 |
# Escape characters
643 |
644 |
You've noticed that underscores _ and * asterisks are used as tag syntaxes. Well you can use literal underscores and asterisk with backslashes \ _ without any spaces in between them;
645 |
646 |
647 |
648 | This is \_ underscore and \* is an asterisk and \` this is a backtick
649 |
650 |
651 |
652 |
Will print out;
653 |
654 |
This is _ underscore and * is an asterisk and ` this is a backtick
655 |
656 |
If you want to use literal \_ just use double backslashes;
657 |
658 |
659 |
660 | This is \\_ underscore and \\* is an asterisk and \\` this is a backtick
661 |
662 |
663 |
664 |
Will print out;
665 |
666 |
This is \_ underscore and \* is an asterisk and \` this is a backtick
667 |
668 |
That's it for basic syntax. Learn how to write base.md files on the next article or learn how to write index.md pages here. Check the source code for this site over here
676 |
677 |
678 |
691 |
692 |
693 |
694 |
695 |
696 |
--------------------------------------------------------------------------------
/License:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/main.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | # usage function
4 | usage() {
5 | cat <<-'EOF'
6 |
7 | For detailed rundown and usage, run 'sh main.sh rundown'"
8 |
9 | sh main.sh config -----> generate an easy to edit config file"
10 | sh main.sh init -------> initialize all files based on sitemap section in config.txt"
11 | sh main.sh navgen -----> generate navigation section from config.txt sitemap section and push it in navigation section of config_file"
12 | sh main.sh indexgen ---> generate a index.md page based on your prompt answers"
13 | sh main.sh add --------> add a post and also an entry to a base.md file and also config.txt sitemap section"
14 | sh main.sh post -------> make a post"
15 | sh main.sh adddir -----> add a whole directory navigation page to all files"
16 | sh main.sh rmdir ------> remove a directory navigation entry page from all files"
17 | sh main.sh remove latest ----> will remove the latest entry made through running sh main.sh add"
18 | sh main.sh remove last dirname/base.md ---> will remove the last article entry from dirname/base.md file (it has to be a base.md file)"
19 | sh main.sh html filename.md ----> generate html format for a single filename.md"
20 | sh main.sh all ----> convert all md files(mentioned in config_file) to html files"
21 | sh main.sh index index.md ----> convert index.md file to index.html"
22 | sh main.sh final ----> arrange all files to a main or final site directory"
23 | sh main.sh rss -----> generate a rss feed of the articles from base.md files"
24 |
25 | EOF
26 | }
27 | # Basic rundown function
28 | rundown() {
29 | cat <<-'EOF'
30 |
31 | This is a basic rundown/CLI usage steps
32 |
33 | Step1: Generate a config file by running 'sh main.sh config'. Then edit the config.txt file on your own. For an example config file, you can see 'https://samiuljoy.github.io/config.txt'. Make sure to add a base.md page on your first entry to every new page except for about and index page. The need for base.md page is to hold records of the different posts and display them on a dedicated page. For more info about basepage syntax please refer to 'https://samiuljoy.github.io/demo/basepage.html'
34 |
35 | Step2: If you're done editing config.txt file, initialize everything that you've declared on your config file by running 'sh main.sh init'. This will create all the files, directories and whatnot
36 |
37 | Step3: Now, generate navigation section by running 'sh main.sh navgen'. This navigation part just adds home, roam and base buttons on your navigation section
38 |
39 | Step4: Now generate an index file with 'sh main.sh indexgen'
40 |
41 | Step5: Now Edit the base.md page if your article is going to be in a directory such as 'blog/firstblog.md'. In such case, first edit 'blog/base.md' page with your text editor. For an example see 'https://samiuljoy.github.io/microblog/base.md' and for syntax documentation, please refer to 'https://samiuljoy.github.io/demo/basepage.html'. Just run 'sh main.sh post' and when it asks for the filename, just add 'blog/base.md' as the filename
42 |
43 | Step6: If you've completed everything above correctly, you can start writing your posts. You can either run 'sh main.sh post' and add manual entries to config.txt, blog/base.md file or you could just run 'sh main.sh add' and let all your entries by added automatically. It's your choice, depends on use case hence, added both post and add option for for variance.
44 |
45 | Step7: Now since you've added all posts and everything, now run 'sh main.sh all'. This will generate html pages for all the files mentioned in 'config.txt'.
46 |
47 | Step8: For convenience you can also run 'sh main.sh final' which will copy all the generated html files into a separate sub-directory
48 |
49 | Step9: Last but not least, you can also generate rss.xml feeds of all your posts. Just run 'sh main.sh rss'
50 |
51 | EOF
52 | }
53 | # global variables
54 | # config file name
55 | config_file="config.txt"
56 | # index file name
57 | index_file="index.md"
58 | # main site dir variable name
59 | main_site="main-site"
60 | # css and js dirs
61 | css_dir="css"
62 | js_dir="js"
63 | # rss file name
64 | rss_file="rss.xml"
65 | # assets directory
66 | assets_dir="assets"
67 |
68 | # Global functions
69 | # Sitemap values
70 | all_sitemap_values() {
71 | all_sitemap_entries="$(sed -n '/^+.*sitemap$/,/^-.*sitemap$/p' $config_file 2> /dev/null | \
72 | grep -v "^+++.*\|^---.*")"
73 | }
74 |
75 | # Check for sitemap section only and sets status based on presence
76 | check_sitemap_status() {
77 | grep -q "^++.*sitemap" $config_file && \
78 | grep -q "^--.*sitemap$" $config_file && \
79 | sitemap_section_present='1' || \
80 | sitemap_section_present='0';
81 | }
82 |
83 | ## check if config file exists
84 | check_config() {
85 | [ ! -f "$config_file" ] && \
86 | echo "file $config_file not found, exiting..." && \
87 | exit 1;
88 | }
89 | check_index() {
90 | [ ! -f "$index_file" ] && \
91 | echo "index file not found.." && \
92 | exit 1;
93 | }
94 | ## check if sitemap section is mentioned in config file
95 | check_sitemap() {
96 | check_sitemap_status;
97 |
98 | if [ "$sitemap_section_present" -ne 1 ]; then
99 | echo "$config_file does not have a sitemap region mentioned, exiting..." && \
100 | exit 1;
101 | fi
102 |
103 | # if sitemap region is less than 3 lines then abort
104 | if [ "$(sed -n '/^++.*sitemap$/,/^--.*sitemap$/p' $config_file | wc -l)" -le 3 ]; then
105 | echo "sitemap region is improperly edited, exiting..." && \
106 | exit 1;
107 | fi
108 | }
109 |
110 | ## check if navigation section is mentioned in config file
111 | nav_check() {
112 | # check for navigation region in config file
113 | grep -q "^+.*navigation$" $config_file && \
114 | grep -q "^-.*navigation$" $config_file && \
115 | navigation_section_present="1";
116 |
117 | [ "$?" -ne 0 ] && \
118 | echo "navigation section is not mentioned in $config_file, perhaps you would want to edit it manually.." && \
119 | exit 1;
120 | }
121 |
122 | ## value variable without index file
123 | vals_noindex() {
124 | # getting values from sitemap region
125 | all_sitemap_values;
126 | vals="$(echo "$all_sitemap_entries" | grep -v "$index_file" | grep ".md$")"
127 | }
128 |
129 | ## value variable with basemd file
130 | vals_basemd() {
131 | # grep base.md values only
132 | all_sitemap_values;
133 | vals="$(echo "$all_sitemap_entries" | grep "base.md$")"
134 | }
135 |
136 | ## value variable for all .md files except index file
137 | vals_allmd() {
138 | # grep base.md values only
139 | all_sitemap_values;
140 | vals="$(echo "$all_sitemap_entries" | grep ".md$")"
141 | }
142 |
143 | ## value variable with all files in sitemap section
144 | vals_all() {
145 | # grep base.md values only
146 | all_sitemap_values;
147 | vals="$(echo "$all_sitemap_entries")"
148 | }
149 |
150 | ## extra post section for quick access, rather than writing same function repeatedly
151 |
152 | ## asks for title
153 | ask_title() {
154 | read -p "Enter the title of the page: " title
155 | val="$title" && empty_check
156 | }
157 |
158 | ## asks for description about the article
159 | ask_describe() {
160 | read -p "Enter little bit of description about the page[optional]: " describe
161 | arg="$author" && skip
162 | }
163 |
164 | ## asks for author name
165 | ask_author() {
166 | read -p "Enter the author of the page[optional]: " author
167 | arg="$author" && skip
168 | }
169 |
170 | ## ask for name of file
171 | ask_name() {
172 | read -p "Name of the file you're about to edit: " current
173 | val="$current" && empty_check
174 | }
175 |
176 | ## generate template for config file
177 | config_generate() {
178 |
179 | # create config file
180 | [ ! -f "$config_file" ] && \
181 | touch $config_file
182 |
183 | check_sitemap_status;
184 |
185 | if [ "$sitemap_section_present" -ne 1 ]; then
186 | cat <<-'EOF'>> $config_file
187 | # Sitemap section -> include files.md here
188 |
189 | ++++++++++sitemap
190 | --------sitemap
191 | EOF
192 | fi
193 |
194 | grep -q "^++.*navigation" $config_file && grep -q "^--.*navigation$" $config_file
195 |
196 | if [ "$?" -ne 0 ]; then
197 | cat <<-'EOF'>> $config_file
198 |
199 | # Navigation Generation section starts here
200 | ++++navigation
201 | .homepage: [home](index.html)
202 | .navmenu: roam
203 | .backpage: [base](base.html)
204 | ----------navigation
205 | EOF
206 | fi
207 |
208 | grep -q "^++.*sitelink" $config_file && grep -q "^--.*sitelink" $config_file
209 |
210 | if [ "$?" -ne 0 ]; then
211 | cat <<-'EOF'>> $config_file
212 |
213 | # This portion is necessary for rss.xml generation. Rss portion starts from here
214 | +++++sitelink
215 | https://yoursitename.com
216 | ------sitelink
217 |
218 | +++++description
219 | some description about your site
220 | -----description
221 |
222 | ++++title
223 | the title of your site
224 | -----title
225 |
226 | # Rss generation portion ends here. The Rss portion is optional
227 | EOF
228 | fi
229 |
230 | grep -q "^# toggle script" $config_file
231 |
232 | if [ "$?" -ne 0 ]; then
233 | cat <<-'EOF'>> $config_file
234 |
235 | # toggle script
236 | # this portion below is necessary
237 | # for javascript functionality
238 |
239 | +++++++script
240 | mode = document.getElementById('switch');
241 | if (! navigator.cookieEnabled)
242 | { mode.style.display = 'none'; }
243 | else if(! localStorage)
244 | { mode.style.display = 'none'; }
245 | else { mode.style.display = 'inline'; }
246 | ------script
247 |
248 | # you can also add custom script files like this
249 | +++++++++add
250 | .script: js/toggle.js
251 | -----------add
252 | # this portion above in between ++add and --add is necessary for
253 | # javascript functionality
254 |
255 | # Footer section (the message portion can be changed)
256 | ++++++++++++++++footer
257 | .class: footer
258 | .message: Made with <3 by [samiuljoy](https://github.com/samiuljoy)
259 | ------------------footer
260 | EOF
261 | fi
262 | }
263 |
264 |
265 | ## initiate everything
266 | init() {
267 | # check for config file
268 | check_config
269 |
270 | # check for sitemap region
271 | check_sitemap
272 |
273 | # get values from sitemap region
274 | vals_noindex
275 |
276 | # creating index.md file
277 | if [ ! -f "$index_file" ]; then
278 | touch $index_file
279 | else
280 | echo "$index_file file exists, skipping creating a new one"
281 | fi
282 |
283 | # make css, js and assets dir
284 | [ ! -d "$css_dir" ] && \
285 | mkdir -p "$css_dir" && echo "css dir created but is empty btw"
286 |
287 | [ ! -d "$js_dir" ] && \
288 | mkdir -p "$js_dir" && echo "js dir created but is empty btw"
289 |
290 | [ ! -d "$assets_dir" ] && \
291 | mkdir -p "$assets_dir" && echo "assets dir created but is empty btw"
292 |
293 | # initialize directories and files based on $sitemap
294 | for i in $vals; do
295 | if [ -d "$(dirname $i)" ]; then
296 | touch "$i"
297 | echo "created $i"
298 | else
299 | mkdir -p "$(dirname $i)" && \
300 | echo "made dir $(dirname $i)" && \
301 | touch "$i" && \
302 | echo "created $i"
303 | fi
304 | done
305 |
306 | # exit status check
307 | [ "$?" = 0 ] && \
308 | echo "directories and files initialized" || \
309 | echo "something went wrong" && \
310 | return 1;
311 | }
312 |
313 |
314 | ## navigation generation
315 | navigation_gen() {
316 |
317 | # check for config file
318 | check_config
319 |
320 | # check for sitemap region
321 | check_sitemap
322 |
323 | # grep basemd values only
324 | vals_basemd
325 |
326 | # check for navigation intent
327 | nav_check
328 |
329 | line_count="$(sed -n '/^+.*navigation$/,/^-.*navigation$/p' $config_file | wc -l)"
330 |
331 | if [ "$line_count" -ge "6" ]; then
332 | read -p "Seems like you made some changes to the navigation section of $config_file, are you sure you want to make further changes? [y/n]: " write
333 | case "$write" in
334 | y|Y|yes|Yes ) break
335 | ;;
336 | n|N|no|No ) echo "not making any changes to the navigation section, exiting..." && \
337 | return 1
338 | ;;
339 | * ) echo "Invalid value..exiting, making no changes.." && \
340 | return 1
341 | ;;
342 | esac
343 | fi
344 | # if everything above returns true, then run this section
345 | # generate navigation values based on dir name
346 | for i in $(echo $vals); do
347 | ddd="$(dirname $i)"
348 | html_val="$(echo $i | sed 's/.*\/\(.*\).md/\1.html/g')"
349 | ddd_val="$(dirname $i | sed 's/\//\\\//g')"
350 | grep -q "\.navpage: \[$ddd_val\]($ddd_val/$html_val)" $config_file || \
351 | sed -i "/^\.backpage:\s/i .navpage: [$ddd_val]($ddd_val\/$html_val)" $config_file
352 | done
353 | }
354 | ## transform markdown article to html
355 | main_generate() {
356 | # needs serious refactoring
357 |
358 | # null argument
359 | [ -z "$1" ] && \
360 | echo "empty file passed" && \
361 | return 1;
362 | # check if file exists
363 | [ ! -f "$1" ] && echo "file $1 does not exist" && return 1;
364 | # check if file is empty, if empty then skip file
365 | [ ! -s "$1" ] && \
366 | echo "file seems to be empty, skipping $1" && \
367 | return 1;
368 | # check if file has a html extension
369 | echo $1 | grep -q "\.html" && \
370 | echo "file with .html can not be modified, use .md(markdown)" && \
371 | return 1;
372 | # functions
373 | file_rename() {
374 | filename="$(echo $orig | \
375 | sed 's/\(.*\).md/\1.html/g')"
376 | touch $filename && \
377 | cat $orig > $filename
378 | }
379 | # function end
380 |
381 | # args
382 | orig="$1"; file_rename
383 |
384 | # check if filename has backslash
385 | echo $filename | grep -q "/" && \
386 | filename_has_backslash="1" || \
387 | filename_has_backslash="0";
388 |
389 | # loop through code blocks, and substitute code blocks to new file/s
390 | grep -q "^\`\`\`[[:digit:]]" $filename
391 |
392 | if [ "$?" = 0 ]; then
393 | code_number=1
394 | upto="$(grep '^```[[:digit:]]\+$' $filename | tail -n1 | cut -c 4-)"
395 | code_directory="$(dirname $filename)/code"
396 | [ ! -d "$code_directory" ] && mkdir -p "$code_directory"
397 |
398 | while [ "$code_number" -le "$upto" ]; do
399 | sed -n "/^\`\`\`$code_number$/,/^\.code$code_number$/p" $filename > "$filename-code$code_number.txt"
400 | sed -i '{ /^\.code[[:digit:]]\+/d
401 | /^```/d
402 | s/^\t//g
403 | }' "$filename-code$code_number.txt"
404 | mv "$filename-code$code_number.txt" $code_directory
405 | code_number="$(( $code_number + 1 ))"
406 | done
407 | fi
408 |
409 | # escape sequences substitution -> bounded
410 | sed -i '/^```.*$/,/^```$/ {
411 | s/\./\./g
412 | s/_/\_/g
413 | s/\!/\!/g
414 | s/\[/\[/g
415 | s/\]/\]/g
416 | s/~/\∼/g
417 | s/\*/\*/g
418 | s/#/\#/g
419 | s/\</g
420 | s/>/\>/g
421 | }' $filename
422 |
423 | # global escape sequences substitution
424 | sed -i '{ s/\\_/\_/g
425 | s/\\\*/\*/g
426 | s/\\`/\`/g
427 | s/\\\[/\[/g
428 | s/\\\]/\]/g
429 | }' $filename
430 |
431 | # global substitution < and > to escape sequences < and >
432 | # within main and footer tags
433 | sed -i '/^++.*main$/,/^--.*main$/ {
434 | s/\<\;/g
435 | /^[^>]/ s/>/\>\;/g }' $filename
436 | sed -i '/^++.*footer$/,/^--.*footer$/ {
437 | s/\<\;/g
438 | /^[^>]/ s/>/\>\;/g }' $filename
439 | # comment -> if arg1 is "-c" then include all custom comments else remove all comments
440 | # see https://samiuljoy.github.io/demo/syntax.html for more info
441 | #if [ "$1" = "-c" ]; then
442 | sed -i 's/\s\/\*\(.*\)\*\//\n/g' $filename
443 | #else
444 | # com="false"
445 | # sed -i '{ s/\s\/\*.*\*\/$//g
446 | # /^\/\*.*\*\/$/d }' $filename
447 | #fi
448 |
449 | # cleaning up double .// to /
450 | sed -i "{ /^+.*head$/,/^-.*head$/ s/\.\/\//.\//g
451 | /^+.*navigation$/,/^-.*navigation$/ s/\.\/\//.\//g
452 | /^+.*script$/,/^-.*script$/ s/\.\/\//.\//g }" $filename
453 |
454 | # inline call-script substitution
455 | # script-src substitution
456 | # additional script section will be removed
457 | # add tab inside script section
458 | sed -i '{
459 | s/^\.call-script:\s\(.*\)$/\t