mirror of
https://github.com/aljazceru/cryptoanarchywiki.github.io.git
synced 2025-12-18 13:44:20 +01:00
added simply docs
This commit is contained in:
46
README.md
46
README.md
@@ -24,3 +24,49 @@
|
||||
#### Screenshot
|
||||
|
||||

|
||||
|
||||
### Install & Configuration
|
||||
|
||||
1. Fork this repository
|
||||
2. Edit site settings inside file of `_config.yml`
|
||||
3. Edit your projects at file of `projects.md`, `_data/projects.json` and inside path of `_project/` _(for detail project)_.
|
||||
4. Edit about yourself inside file of `about.md`
|
||||
|
||||
### How to Use?
|
||||
|
||||
**a. Add new Categories**
|
||||
|
||||
All categories saved inside path of `category/`, you can see existed categories.
|
||||
|
||||
**b. Add new Posts**
|
||||
|
||||
* All posts bassed on markdown syntax _(please googling)_. allowed extensions if `*.markdown` or `*.md`.
|
||||
* This files can found at the path of `_posts/`.
|
||||
* and the name of files are following `<date:%Y-%m-%d>-<slug>.<extension>`, for example:
|
||||
|
||||
```
|
||||
2013-09-23-welcome-to-jekyll.md
|
||||
|
||||
# or
|
||||
|
||||
2013-09-23-welcome-to-jekyll.markdown
|
||||
```
|
||||
|
||||
Inside the file of it,
|
||||
|
||||
```
|
||||
---
|
||||
layout: post # (require) default post layout
|
||||
title: "Your Title" # (require) a string title
|
||||
date: 2016-04-20 19:51:02 +0700 # (require) a post date
|
||||
categories: [python, django] # (custom) some categories, but makesure these categories already exists inside path of `category/`
|
||||
tags: [foo, bar] # (custom) tags only for meta `property="article:tag"`
|
||||
image: Broadcast_Mail.png # (custom) image only for meta `property="og:image"`, save your image inside path of `static/img/_posts`
|
||||
---
|
||||
|
||||
# your content post with markdown syntax goes here...
|
||||
```
|
||||
|
||||
### Contributing
|
||||
|
||||
Feel free to [open a bug](/issues) or [contribute to code](/pulls)!
|
||||
|
||||
Reference in New Issue
Block a user