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

Test README.md

Browse Source
This commit is contained in:
manfromhuh 2022-07-02 12:48:30 -04:00
parent df45c61fb4
commit cfc878013d
1 changed files with 89 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
README.md Normal file
View File

@ -0,0 +1,89 @@
# 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).
## Requirements
* Currently tested with PHP 7.4
* Some shell access is necessary.
* The recommend way is via ssh.
* I don't see a technical reason it can't work with a web manager like cPannel or Ajenti as long has you have the ability to upload files and manage files.
## Publishing
## Description
### blog
Contains the blog articles. The articles are placed in subdirectories of `by_year` according to the month they were published.
### common
This directory contains the files and libraries used to render the site's pages.
#### Composer files
* composer.json
* composer.lock
* [/common/vendor]() - Stores the composer files and libraries managed via composer.
#### CSS
* [styles.css](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
#### JS
* font_size.js
* page_format.js - The main
* gallery.js
#### PHP
* [footer.php]()
* [get_month_name.php]()
* [h1_month.php]()
* [header.php]()
* [index.php]()
* [markdown.php]()
* [md_read.php]()
* [menu.php]()
* [modal.php]()
* [page_menu.php]()
* [page_menu_table.php]()
* [path_menu.php]()
#### /common/error_pages/
* /common/403.php
* /common/404.php
* /common/500.php
#### /common/imgs/
Images used site wide.
* [cursor.gif]() - Blinking cursor used on the front page.
* [icon-rss.png]() - RSS icon
#### /common/prisim
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
#### index.php
Displays all of the reverent license and the components they apply to.
* simple_blog is licensed GPLv2. This cannot be changed.
* Default license for articles published. This is [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/) by default. This licensed can be changed however the site admin wishes.
* [Jmenu](https://github.com/jamesjohnson280/JMenu) is licensed MIT. This cannot be changed.
* [Parsedown](https://github.com/erusev/parsedown) is licensed MIT. This cannot be changed.
* [Parsedown-extra](https://github.com/erusev/parsedown-extra) is licensed MIT. This cannot be changed.
Copies of all these licenses can be found in the `/license/` directory.