manfromhuh/simple_blog
1
0
Fork 0
forked from 20xd6/simple_blog
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Add Completed README.md

Browse Source
This commit is contained in:
manfromhuh 2022-07-05 14:18:49 -04:00
parent cfc878013d
commit e1ac241f2a
1 changed files with 64 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -1,6 +1,6 @@
# simple_blog
simple_blog is a basic blogging platform. It is designed to be a straightforward way to publish articles written in Markdown and display them using a renderer written in PHP. There is no login page or any way to manage simple_blog from the web. All management is done via the command line. This can be done with a shell script or with the python based [simple_blog_cms](https://20xd6.net/git/20xd6/simple_blog_cms).
simple_blog is a basic blogging platform. It is designed to be a straightforward way to publish articles written in Markdown and display them using a renderer written in PHP. There is no login page or any way to manage simple_blog from the web. All management is done via the command line. This can be done with a shell script or with the python based [simple_blog_cms](/git/20xd6/simple_blog_cms).
## Requirements
@ -11,11 +11,54 @@ simple_blog is a basic blogging platform. It is designed to be a straightforward
## Publishing
## Description
Publishing can be done manually or with a script that accomplishes the following tasks.
1. Create a directory under `/blog/by_year/$CURRENT_YEAR/$CURRENT_MONTH/`
* For a post in January of 2022 this would be `/blog/by_year/2022/01/`
* The directory should start with a numeral otherwise it will be sorted alphabetically
2. Place a file named `article.md` containing the MarkDown formatted text of the article in the directory created in the previous step
3. Copy or symlink `/common/index.php` into the directory created in step 1
4. Place a file named `tags` containing a comma separated list of tags for the article in the directory created in step 1
5. Add the article's relative path and title to `/by_tag/tags.csv` under the appropriate headings.
The recommended method is to use [simple_blog_cms](/git/20xd6/simple_blog_cms "simple_blog_cms")
## Article Tags
### Per-article List
A file named `tags` is placed in the directory for each article. It should contain a comma separated list of tags being applied to the article. This will be parsed and displayed by [`/common/md_read.php`](/git/20xd6/simple_blog/src/branch/master/common/md_read.php) at the bottom of the article.
### by_tags
This folder contains an index file that displays an article list generated by parsing the `tags.csv` file. A format example is displayed below.
| "PHP" | "JS" | "Religion" | "Catholic" |
| ----- | ---- | ---------- | ---------- |
| "/blog/by_year/2021/10/03_Forcing_Elements_to_reload/" | "/blog/by_year/2021/10/03_Forcing_Elements_to_reload/" |"/blog/by_year/2021/10/reproduction_of_Gainer_Bishop_Ronald_4-1-16/" | reproduction_of_Gainer_Bishop_Ronald_4-1-16/" |
| "Forcing page elements to reload" | "Forcing page elements to reload" | "Open Letter to Bishop Ronald Gainer" | "Open Letter to Bishop Ronald Gainer" |
| "/blog/by_year/2022/06/28_A_Test_Post/"| | |
| "A Test Post" | | |
## File Descriptions
### blog
Contains the blog articles. The articles are placed in subdirectories of `by_year` according to the month they were published.
Contains the blog articles. The articles are placed in subdirectories of `by_year` according to the year and month they were published.
```
├── by_year
│   ├── 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
```
### common
@ -36,29 +79,29 @@ This directory contains the files and libraries used to render the site's pages.
#### JS
* font_size.js
* page_format.js - The main
* [page_format.js]() - The main JS file used for formatting and adding extra functions to pages.
* gallery.js
#### PHP
* [footer.php]()
* [get_month_name.php]()
* [h1_month.php]()
* [header.php]()
* [index.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.
* [markdown.php]()
* [md_read.php]()
* [menu.php]()
* [modal.php]()
* [page_menu.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]()
#### /common/error_pages/
* /common/403.php
* /common/404.php
* /common/500.php
* [/common/403.php]() - The 403 not allowed page.
* [/common/404.php]() - The 404 page.
* [/common/500.php]() - Displayed for all HTTP 500 errors
#### /common/imgs/
@ -74,7 +117,11 @@ Files for the prism syntax highlighter.
### license
This directory contains all the licensing information for simple_blog. simple_blog is licensed under the GPLv2 but uses components that are licensed under the MIT Open Source license. These components are
This directory contains all the licensing information for simple_blog. simple_blog is licensed under the GPLv2 but uses components that are licensed under the MIT Open Source license. These components are:
* [Jmenu](https://github.com/jamesjohnson280/JMenu)
* [Parsedown](https://github.com/erusev/parsedown)
* [Parsedown-extra](https://github.com/erusev/parsedown-extra)
#### index.php