Updated to make it compatible with latest mkdocs chages
This commit is contained in:
parent
fa00f810c3
commit
e986effb13
|
@ -1,4 +1,7 @@
|
|||
.toctree-l3 { padding-left: 50px !important }
|
||||
.toctree-l3 { margin-left: -12px; }
|
||||
.wy-menu-vertical span { padding-top: 20px }
|
||||
.wy-menu-vertical .subnav a { padding: 0.4045em 1.627em }
|
||||
li.toctree-l3:first-child { display: none }
|
||||
code { padding: 3px 6px; font-size: 80% !important; border-bottom: 2px solid #e1e4e5; color: black }
|
||||
code.hljs { font-size: 90% !important }
|
||||
pre { margin-bottom: 40px }
|
||||
|
@ -9,7 +12,7 @@ pre { margin-bottom: 40px }
|
|||
.section table td { padding: 8px 15px; border: 1px solid #e1e4e5; background-color: #f3f6f6 }
|
||||
.section table tr:nth-child(even) td { background-color: #FFF }
|
||||
|
||||
li.toctree-l2:first-child { display: none }
|
||||
/*li.toctree-l2:first-child { display: none }*/
|
||||
|
||||
h4 em { font-style: normal; color: #999 }
|
||||
hr { margin: 50px 0 }
|
||||
|
@ -18,7 +21,7 @@ hr { margin: 50px 0 }
|
|||
ul { font-size: 16px }
|
||||
|
||||
/* Theme default color is the same color as links; Text using the same color of links is bad usability */
|
||||
h3, h4, h5, h6 { color: #333333 }
|
||||
h3, h4, h5, h6 { color: #2980b9 }
|
||||
|
||||
.section a { border-bottom: 1px solid #BBB; color: #000 !important }
|
||||
.section a:hover { border-bottom: 1px solid #3091d1 }
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
# Coding standards if you want to collaborate to ZeroNet
|
||||
- Use tabs instead of spaces (tab size: 4)
|
||||
- Comments starts with # Capitalized word
|
||||
- Follow [PEP8](https://www.python.org/dev/peps/pep-0008/)
|
||||
- Simple is better than complex
|
||||
- Premature optimization is the root of all evil
|
||||
|
|
@ -8,3 +8,24 @@
|
|||
Before you start anything big please, open a [new discussion](https://github.com/HelloZeroNet/ZeroNet/issues/new),
|
||||
so you can make sure nobody is working on it already and we can share our ideas to make the best out of it.
|
||||
- You can [donate](zeronet_development/donate) bitcoins to support ZeroNet.
|
||||
|
||||
# Coding standards if you want to collaborate to ZeroNet
|
||||
- Follow [PEP8](https://www.python.org/dev/peps/pep-0008/)
|
||||
- Simple is better than complex
|
||||
- Premature optimization is the root of all evil
|
||||
|
||||
### Naming
|
||||
- ClassNames: Capitalized, CamelCased
|
||||
- functionNames: starts with lowercase, camelCased
|
||||
- variable_names: lowercased, under_scored
|
||||
|
||||
### Variables
|
||||
- file_path: File path realtive to working dir (data/17ib6teRqdVgjB698T4cD1zDXKgPqpkrMg/css/all.css)
|
||||
- inner_path: File relative to site dir (css/all.css)
|
||||
- file_name: all.css
|
||||
- file: Python file object
|
||||
- privatekey: Private key for the site (without _)
|
||||
|
||||
### Source files directories and naming
|
||||
- One class per file is preferred
|
||||
- Source file name and directory comes from ClassName: WorkerManager class = Worker/WorkerManager.py
|
|
@ -3,7 +3,7 @@
|
|||
# Help to keep ZeroNet development alive
|
||||
|
||||
|
||||
## ZeroNet: 2015 second quarter development
|
||||
## ZeroNet: 2015 third quarter development
|
||||
<a href="bitcoin:1QDhxQ6PraUZa21ET5fYUCPgdrwBomnFgX?Label=ZeroNet+donation" class="bitcoinbar" data-address="1QDhxQ6PraUZa21ET5fYUCPgdrwBomnFgX" data-goal="3.0"></a>
|
||||
|
||||
* General donation towards ZeroNet development
|
||||
|
@ -32,8 +32,6 @@ Benefits:
|
|||
|
||||
## <s>Namecoin domain support</s> (done in version 0.2.8)
|
||||
|
||||
![Namecoin](img/domain.png)
|
||||
|
||||
* Use Namecoin domain names to access sites
|
||||
|
||||
Benefits:
|
|
@ -7,7 +7,7 @@
|
|||
_These commands handled by wrapper frame and does not sent to UiServer using websocket_
|
||||
|
||||
|
||||
##### wrapperConfirm _message, [button_caption]_
|
||||
#### wrapperConfirm _message, [button_caption]_
|
||||
Display a notification with confirm button
|
||||
|
||||
Parameter | Description
|
||||
|
|
|
@ -8,7 +8,7 @@ The homepage of ZeroNet
|
|||
- Site actions: Update, Pause, Resume, Delete
|
||||
- If new version available update ZeroNet with one click
|
||||
|
||||
![ZeroHello](img/zerohello.png)
|
||||
![ZeroHello](/img/zerohello.png)
|
||||
|
||||
Address: [1EU1tbG9oC1A8jz2ouVwGZyQ5asrNsE4Vr](http://127.0.0.1:43110/1EU1tbG9oC1A8jz2ouVwGZyQ5asrNsE4Vr)
|
||||
|
||||
|
@ -29,7 +29,7 @@ How does it works?
|
|||
- The bot modify the `message.json` file, signs it using the private key and publish to other peers
|
||||
- If the site modification reaches your client the message will appear to your browser
|
||||
|
||||
![ZeroBoard](img/zeroboard.png)
|
||||
![ZeroBoard](/img/zeroboard.png)
|
||||
|
||||
Address: [1Gfey7wVXXg1rxk751TBTxLJwhddDNfcdp](http://127.0.0.1:43110/1Gfey7wVXXg1rxk751TBTxLJwhddDNfcdp)
|
||||
|
||||
|
@ -54,7 +54,7 @@ How does it works?
|
|||
- Your ZeroNet client signs the new, modified files and publish directly to other peers
|
||||
- You site will be accessible until at least 1 peer (visitor) computer is active
|
||||
|
||||
![ZeroBlog](img/zeroblog.png)
|
||||
![ZeroBlog](/img/zeroblog.png)
|
||||
|
||||
Address: [1BLogC9LN4oPDcruNz3qo1ysa133E9AGg8](http://127.0.0.1:43110/1BLogC9LN4oPDcruNz3qo1ysa133E9AGg8)
|
||||
|
||||
|
@ -79,7 +79,7 @@ How does it works?
|
|||
- To be able to distribute your own content (Topics, Comments, Upvotes, etc.) you request an own file from the site owner
|
||||
- After the registration is done you can publish your file's modifications directly to other peers without contacting the site owner again
|
||||
|
||||
![ZeroTalk](img/zerotalk.png)
|
||||
![ZeroTalk](/img/zerotalk.png)
|
||||
|
||||
Address: [1TaLk3zM7ZRskJvrh3ZNCDVGXvkJusPKQ](http://127.0.0.1:43110/1TaLk3zM7ZRskJvrh3ZNCDVGXvkJusPKQ)
|
||||
|
||||
|
|
30
mkdocs.yml
30
mkdocs.yml
|
@ -9,21 +9,19 @@ extra_javascript: [docs.js]
|
|||
|
||||
|
||||
pages:
|
||||
- [index.md, Introduction]
|
||||
|
||||
- [index.md, Using ZeroNet, Introduction]
|
||||
- [using_zeronet/installing.md, Using ZeroNet, Installing]
|
||||
- [using_zeronet/sample_sites.md, Using ZeroNet, Sample sites]
|
||||
- [using_zeronet/create_new_site.md, Using ZeroNet, Create new site]
|
||||
|
||||
- [site_development/getting_started.md, Site Development, Getting Started]
|
||||
- [site_development/zeroframe_api_reference.md, Site Development, ZeroFrame API reference]
|
||||
- [site_development/content_json.md, Site Development, Structure of content.json]
|
||||
- [site_development/dbschema_json.md, Site Development, Structure of dbschema.json]
|
||||
|
||||
- [zeronet_development/coding_conventions.md, ZeroNet Development, Coding conventions]
|
||||
- [zeronet_development/network_protocol.md, ZeroNet Development, Network protocol]
|
||||
- [zeronet_development/contributing.md, ZeroNet Development, Contributing to ZeroNet]
|
||||
- [zeronet_development/donate.md, ZeroNet Development, Donation]
|
||||
- Introduction: "index.md"
|
||||
- Start using ZeroNet:
|
||||
- "Installing": using_zeronet/installing.md
|
||||
- "Sample sites": using_zeronet/sample_sites.md
|
||||
- "Create new site": using_zeronet/create_new_site.md
|
||||
- "Site Development":
|
||||
- "Getting Started": "site_development/getting_started.md"
|
||||
- "ZeroFrame API reference": "site_development/zeroframe_api_reference.md"
|
||||
- "Structure of content.json": "site_development/content_json.md"
|
||||
- "Structure of dbschema.json": "site_development/dbschema_json.md"
|
||||
- "Help ZeroNet deleopment":
|
||||
- "Contributing to ZeroNet": "help_zeronet/contributing.md"
|
||||
- "Network protocol": "help_zeronet/network_protocol.md"
|
||||
- "Donation": "help_zeronet/donate.md"
|
||||
|
||||
theme: readthedocs
|
||||
|
|
|
@ -1,3 +0,0 @@
|
|||
start "docs" http://127.0.0.1:8000/
|
||||
python -m "mkdocs.main" serve
|
||||
pause
|
Loading…
Reference in New Issue