skiqqy.xyz/README.md

89 lines
1.9 KiB
Markdown
Raw Normal View History

2020-10-23 23:31:04 +00:00
# Skiqqy.xyz
2020-11-03 18:59:14 +00:00
This is my website, which is hosted [here](https://skiqqy.xyz).
2020-10-23 23:31:04 +00:00
## Building
2020-11-16 17:01:01 +00:00
There are two approaches
2020-10-23 23:31:04 +00:00
````
2020-11-16 17:01:01 +00:00
$ make # Build everything.
````
Or
````
$ make demo # Builds everything with injected warning text.
2020-10-23 23:45:13 +00:00
````
2020-11-16 17:01:01 +00:00
### Static site
2020-10-23 23:45:13 +00:00
````
2020-11-16 17:01:01 +00:00
$ make build
2020-10-23 23:31:04 +00:00
````
2021-03-25 07:35:13 +00:00
### Web Pages
In the current iteration, to add a new page to the website create a `raw/<file>.txt`, this will generate an html file placed in `site/<file>.html`. For examples look inside `raw/`.
This file uses a custom markup called skup (skiqqy markup) that has the following features.
#### Blocks
Wrap text/skup/html in a block, please note the `.` that terminates the title as well as the `EBLOCK` that terminates the block.
```
SBLOCK <Title>.
<text/skup/html>
EBLOCK
```
This will generate html that looks something like the following.
```
+------------------------------------+
| |
| <Title> |
| |
| <text/skup/html> |
| |
+------------------------------------+
```
#### Newlines
To force a newline simply use `\\` (just like LaTeX).
2020-11-16 17:01:01 +00:00
### Static Blog
2020-05-03 18:58:27 +00:00
The goal of this website is to serve 'static' content that gets updated
through scripts, this is to reduce bloat, and to ensure a fast website.
To create the 'full' website, it is important to first run,
````
2020-10-23 23:52:12 +00:00
$ make blog
2020-05-03 18:58:27 +00:00
````
as this will create blog posts from the files found in `blogs/RawBlogs`, and
and setup all the links and stuff for them, these blog files are written
with a custom markup lanuage with very simple markups, Currently there are the
following:
---
(1)
````
[
Normal Text Goes Here.
]
````
---
(2)
````
(
Block Text Goes here.
)
````
---
(1) Will generate:
````
Normal Text Goes Here.
````
(2) Will generate:
````
+--------------------------+
| |
| Block Text Goes Here |
| |
+--------------------------+
````