Compare commits
9 Commits
Author | SHA1 | Date | |
---|---|---|---|
fa921bcf39 | |||
c312dbf995 | |||
b91d699261 | |||
858d880837 | |||
a06e7dabeb | |||
e624e7c287 | |||
b4ffc0b9f8 | |||
b40b877a3f | |||
8da50f2841 |
74
README.md
74
README.md
@ -40,6 +40,11 @@ This folder contains an index file that displays an article list generated by pa
|
||||
| "/blog/by_year/2022/06/28_A_Test_Post/"| | |
|
||||
| "A Test Post" | | |
|
||||
|
||||
## Authors
|
||||
|
||||
Post authors can be kept under `/blog/authors/`. Authors are kept in separate directories.
|
||||
|
||||
The authors directory is parsed by [`article.php`](/git/20xd6/simple_blog/src/commit/7734de9fa483257a90a658b74b78b47e4de716e2/common/php/article.php#L25) using a file named `author` from the post's directory. This file should contain a single line with the author's name.
|
||||
|
||||
## File Descriptions
|
||||
|
||||
@ -49,14 +54,14 @@ Contains the blog articles. The articles are placed in subdirectories of `by_yea
|
||||
|
||||
```
|
||||
├── by_year
|
||||
│ ├── 2021
|
||||
│ │ ├── 12
|
||||
│ │ └── index.php -> /path/to/common/index.php
|
||||
│ ├── 2022
|
||||
│ │ ├── 01
|
||||
│ │ ├── 02
|
||||
│ │ └── index.php -> /path/to/common/index.php
|
||||
│ └── index.php
|
||||
│ ├── 2021
|
||||
│ │ ├── 12
|
||||
│ │ └── index.php -> /path/to/common/index.php
|
||||
│ ├── 2022
|
||||
│ │ ├── 01
|
||||
│ │ ├── 02
|
||||
│ │ └── index.php -> /path/to/common/index.php
|
||||
│ └── index.php
|
||||
└── index.php -> /path/to/common/index.php
|
||||
```
|
||||
|
||||
@ -69,49 +74,44 @@ This directory contains the files and libraries used to render the site's pages.
|
||||
* composer.lock
|
||||
* [/common/vendor]() - Stores the composer files and libraries managed via composer.
|
||||
|
||||
#### CSS
|
||||
#### [CSS](/git/20xd6/simple_blog/src/branch/master/common/css)
|
||||
|
||||
* [styles.css](/git/20xd6/simple_blog/src/branch/master/common/styles.css) - The main site CSS.
|
||||
* [jmenu.css]() - Used to render the responsive menus.
|
||||
* [print.css]() - Used to style printed pages.
|
||||
* [gallery.css]() - Styles the floating
|
||||
* [styles.css](/git/20xd6/simple_blog/src/branch/master/common/css/styles.css) - The main site CSS.
|
||||
* [jmenu.css](/git/20xd6/simple_blog/src/branch/master/common/css/jmenu.css) - Used to render the responsive menus.
|
||||
* [print.css](/git/20xd6/simple_blog/src/branch/master/common/css/print.css) - Used to style printed pages.
|
||||
|
||||
#### JS
|
||||
#### [JS](/git/20xd6/simple_blog/src/branch/master/common/js)
|
||||
|
||||
* font_size.js
|
||||
* [page_format.js]() - The main JS file used for formatting and adding extra functions to pages.
|
||||
* gallery.js
|
||||
* [page_format.js](/git/20xd6/simple_blog/src/branch/master/common/js/page_format.js) - The main JS file used for formatting and adding extra functions to pages.
|
||||
|
||||
#### PHP
|
||||
#### [PHP](/git/20xd6/simple_blog/src/branch/master/common/php)
|
||||
|
||||
* [footer.php]() - The common page footer. Contains copyright information and links to the license.
|
||||
* [get_month_name.php]() - Translates a numeral month into the corresponding name. I.E. 01 into January.
|
||||
* [h1_month.php]() - Adds the proper `<h1>` heading based on the location of the
|
||||
* [header.php]() - The common page header.
|
||||
* [index.php]() - The index file used for most of the pages on the site.
|
||||
* [footer.php](/git/20xd6/simple_blog/src/branch/master/common/php/footer.php) - The common page footer. Contains copyright information and links to the license.
|
||||
* [get_month_name.php](/git/20xd6/simple_blog/src/branch/master/common/php/get_month_name.php) - Translates a numeral month into the corresponding name. I.E. 01 into January.
|
||||
* [h1_month.php](/git/20xd6/simple_blog/src/branch/master/common/php/h1_month.php) - Adds the proper `<h1>` heading based on the location of the
|
||||
* [header.php](/git/20xd6/simple_blog/src/branch/master/common/php/header.php) - The common page header.
|
||||
* [index.php](/git/20xd6/simple_blog/src/branch/master/common/php/index.php) - The index file used for most of the pages on the site.
|
||||
* [markdown.php]()
|
||||
* [md_read.php]() - Renders Markdown files and adds
|
||||
* [menu.php]() - Generates the blog menu items in the navigation menu.
|
||||
* [modal.php]() - Adds the modal `<div>` for displaying the image pop out.
|
||||
* [page_menu.php]() - Generates a menu from the files and directories where it's run from.
|
||||
* [page_menu_table.php]()
|
||||
* [path_menu.php]()
|
||||
* [md_read.php](/git/20xd6/simple_blog/src/branch/master/common/php/md_read.php) - Renders Markdown files and adds
|
||||
* [menu.php](/git/20xd6/simple_blog/src/branch/master/common/php/menu.php) - Generates the blog menu items in the navigation menu.
|
||||
* [modal.php](/git/20xd6/simple_blog/src/branch/master/common/php/modal.php) - Adds the modal `<div>` for displaying the image pop out.
|
||||
* [page_menu.php](/git/20xd6/simple_blog/src/branch/master/common/php/page_menu.php) - Generates a menu from the files and directories where it's run from.
|
||||
|
||||
#### /common/error_pages/
|
||||
#### [/common/error_pages/](/git/20xd6/simple_blog/src/branch/master/common/error_pages)
|
||||
|
||||
* [/common/403.php]() - The 403 not allowed page.
|
||||
* [/common/404.php]() - The 404 page.
|
||||
* [/common/500.php]() - Displayed for all HTTP 500 errors
|
||||
* [403.php](/git/20xd6/simple_blog/src/branch/master/common/error_pages/403.php) - The 403 not allowed page.
|
||||
* [404.php](/git/20xd6/simple_blog/src/branch/master/common/error_pages/404.php) - The 404 page.
|
||||
* [500.php](/git/20xd6/simple_blog/src/branch/master/common/error_pages/500.php) - Displayed for all HTTP 500 errors
|
||||
|
||||
#### /common/imgs/
|
||||
#### [/common/imgs/](/git/20xd6/simple_blog/src/branch/master/common/imgs)
|
||||
|
||||
Images used site wide.
|
||||
|
||||
* [cursor.gif]() - Blinking cursor used on the front page.
|
||||
* [icon-rss.png]() - RSS icon
|
||||
* [cursor.gif](/git/20xd6/simple_blog/src/branch/master/common/imgs/cursor.gif) - Blinking cursor used on the front page.
|
||||
* [icon-rss.png](/git/20xd6/simple_blog/src/branch/master/common/imgs/icon-rss.png) - RSS icon
|
||||
|
||||
|
||||
#### /common/prisim
|
||||
#### [/common/prisim](/git/20xd6/simple_blog/src/branch/master/common/prisim)
|
||||
|
||||
Files for the prism syntax highlighter.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user