Updated readme
This commit is contained in:
parent
8b688d1428
commit
ce34b5fd62
53
README.md
53
README.md
|
@ -1,8 +1,51 @@
|
|||
# yggpi
|
||||
This is my website root, I plan on improving it over time
|
||||
|
||||
## Details
|
||||
The purpose of this repo is to 'act' as the root of my website, allowing for
|
||||
easier transfer to different domains, and editing the website, as wherever the
|
||||
website is hosted, the website will display what ever is on master, with
|
||||
daily updates (this will be handled by a script.
|
||||
## Static Blog
|
||||
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,
|
||||
````
|
||||
make blog
|
||||
````
|
||||
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 |
|
||||
| |
|
||||
+--------------------------+
|
||||
````
|
||||
|
||||
## Reason for C
|
||||
Its fast. Aint no body got time for bloated stuff.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
<a href="https://github.com/skippy404/skippy404,github.io">View page source</a>
|
||||
<a href="https://github.com/skippy404/skippy404.github.io">View page source</a>
|
||||
|
||||
</pre>
|
||||
</pre>
|
||||
|
|
Loading…
Reference in New Issue