mirror of
				https://github.com/flynx/pWiki.git
				synced 2025-10-31 02:50:08 +00:00 
			
		
		
		
	cleanup docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
		
							parent
							
								
									d514122694
								
							
						
					
					
						commit
						b039a1224f
					
				| @ -631,23 +631,24 @@ var setup = function(){ | |||||||
|   - ### Formatting |   - ### Formatting | ||||||
|     - The formatting mostly adheres to the markdown spec with a few minor differences |     - The formatting mostly adheres to the markdown spec with a few minor differences | ||||||
|     - |     - | ||||||
|     - Styles: |     - # Node styles: | ||||||
|       - Automatic Headings |       - # Automatic Headings | ||||||
|  |         - Heading level is determined by topology | ||||||
|  |         - # Heading | ||||||
|  |           - # Heading | ||||||
|  |             - # Heading | ||||||
|  |               - ... | ||||||
|  |         - NOTE: Heading created via `@` will not show up in index. | ||||||
|  |       - # Manual Headings (disabled) | ||||||
|  |         collapsed:: true | ||||||
|         - @ Heading 1 |         - @ Heading 1 | ||||||
|           - @ Heading 2 |         - @@ Heading 2 | ||||||
|             - @ Heading 3 |         - @@@ Heading 3 | ||||||
|               - @ Heading 4 |         - @@@@ Heading 4 | ||||||
|                 - @ Heading 5 |         - @@@@@ Heading 5 | ||||||
|                   - @ Heading 6 |         - @@@@@@ Heading 6 | ||||||
|       - Manual Headings |       - # Text | ||||||
|         - # Heading 1 |       - # Lists:: | ||||||
|         - ## Heading 2 |  | ||||||
|         - ### Heading 3 |  | ||||||
|         - #### Heading 4 |  | ||||||
|         - ##### Heading 5 |  | ||||||
|         - ###### Heading 6 |  | ||||||
|       - Text |  | ||||||
|       - Lists:: |  | ||||||
|         - bullet: |         - bullet: | ||||||
|           - a: |           - a: | ||||||
|             collapsed:: true |             collapsed:: true | ||||||
| @ -675,21 +676,25 @@ var setup = function(){ | |||||||
|             - y |             - y | ||||||
|             - z |             - z | ||||||
|           - c |           - c | ||||||
|  |       - # Quoting | ||||||
|         - > quote |         - > quote | ||||||
|       - Notes |       - # Notes | ||||||
|           - NOTE: a note text |           - NOTE: a note text | ||||||
|           - NOTE: |           - NOTE: | ||||||
|             - a root note can also be empty |             - a root note can also be empty | ||||||
|             - click on the outer border to edit root |             - click on the outer border to edit root | ||||||
|  |       - # Comments | ||||||
|         - // C-style comment |         - // C-style comment | ||||||
|         - ; ASM-style comment |         - ; ASM-style comment | ||||||
|       - XXX Highlight |       - XXX Highlight | ||||||
| 	  - Status (toggle all via: `alt-s`) |     - # Status  | ||||||
|         - DONE Done (toggled via: `alt-x`) |       - Status of any node can be toggled via: `alt-s` | ||||||
|         - REJECT Reject (toggled via: `alt-r`) |         - DONE Done (explicitly toggled via: `alt-x`) | ||||||
|  |         - REJECT Reject (explicitly toggled via: `alt-r`) | ||||||
|  |     - # Inline styles: | ||||||
|       - Basic inline *bold*, _italic_ and ~striked~ |       - Basic inline *bold*, _italic_ and ~striked~ | ||||||
|       - Marking ==text== |       - Marking ==text== | ||||||
|     - Code: |     - # Code: | ||||||
|       - Inline quoting `html <b>code</b>` |       - Inline quoting `html <b>code</b>` | ||||||
|       - code blocks |       - code blocks | ||||||
|         ```javascript |         ```javascript | ||||||
| @ -697,10 +702,11 @@ var setup = function(){ | |||||||
| 
 | 
 | ||||||
|         console.log(text) |         console.log(text) | ||||||
|         ``` |         ``` | ||||||
| 	- Line |     - # Line | ||||||
|       - --- |       - --- | ||||||
| 	- Markers: ASAP, TEST, BUG, FIX, HACK, STUB, WARNING, and CAUTION  |     - # Markers:  | ||||||
|     - Basic task management |       - ASAP, TEST, BUG, FIX, HACK, STUB, WARNING, and CAUTION  | ||||||
|  |     - # Basic task management | ||||||
|       - [%] Completion status |       - [%] Completion status | ||||||
|         - Inline [X] checkboxes [_] |         - Inline [X] checkboxes [_] | ||||||
|         - To do items/blocks |         - To do items/blocks | ||||||
| @ -709,22 +715,23 @@ var setup = function(){ | |||||||
|           - [X] done item |           - [X] done item | ||||||
|           - [_] we can also add inline [x] checkboxes and states: [%] |           - [_] we can also add inline [x] checkboxes and states: [%] | ||||||
|         - navigating checkboxes in view mode can be done via `ctrl-left` / `ctrl-right` and toggling is done via `space` |         - navigating checkboxes in view mode can be done via `ctrl-left` / `ctrl-right` and toggling is done via `space` | ||||||
| 	- links |     - # links | ||||||
|       - [link](about:blank) |       - [link](about:blank) | ||||||
|       - [local links](#attributes) |       - [local links](#attributes) | ||||||
|       - https://example.com |       - https://example.com | ||||||
|       - ./path/to/file /path/to -- _not supported yet_ |       - ./path/to/file /path/to -- _not supported yet_ | ||||||
|     - Tables |     - # Tables | ||||||
|       - | a | b | c | |       - | a | b | c | | ||||||
|         | 1 | 2 | 3 | |         | 1 | 2 | 3 | | ||||||
|         | 11 | 22 | 33 | |         | 11 | 22 | 33 | | ||||||
|     - Symbols -- _should these be ligatures?_ |     - # Symbols | ||||||
|  |       - _should these be ligatures?_ | ||||||
|       - (i), (c), /!\, ... |       - (i), (c), /!\, ... | ||||||
|       - -- and --- |       - -- and --- | ||||||
|     - Table of content |     - # Table of content | ||||||
|       - Global |       - # Global | ||||||
|         - TOC |         - TOC | ||||||
|       - Local |       - # Local | ||||||
|         - toc |         - toc | ||||||
|         - demo content |         - demo content | ||||||
|           collapsed:: true |           collapsed:: true | ||||||
| @ -733,24 +740,24 @@ var setup = function(){ | |||||||
|             - @ Heading |             - @ Heading | ||||||
|               - @ Heading |               - @ Heading | ||||||
|           - @ Heading |           - @ Heading | ||||||
|     - Templating: |     - # Templating: | ||||||
|       - Inline |       - # Inline | ||||||
|         - TEMPLATE |         - TEMPLATE | ||||||
|           [ ]  |           [ ]  | ||||||
|         - [ ] example item |         - [ ] example item | ||||||
|       - Nested |       - # Nested | ||||||
|         - TEMPLATE creates [below] |         - TEMPLATE creates [below] | ||||||
|           - [ ]  |           - [ ]  | ||||||
|         - [ ] example item |         - [ ] example item | ||||||
|         - TEMPLATE^ creates [above] |         - TEMPLATE^ creates [above] | ||||||
|           - [ ]  |           - [ ]  | ||||||
|       - Multiple nested |       - # Multiple nested | ||||||
|         - TEMPLATE [\ASAP] [ToDo] [Note] |         - TEMPLATE [\ASAP] [ToDo] [Note] | ||||||
|           - [ ] ASAP  |           - [ ] ASAP  | ||||||
|           - [ ]  |           - [ ]  | ||||||
|           -  |           -  | ||||||
|         - Q: should we include button text in item??? |         - Q: should we include button text in item??? | ||||||
|     - Attributes: |     - # Attributes: | ||||||
|       id:: attributes |       id:: attributes | ||||||
|       - collapsed |       - collapsed | ||||||
|         collapsed:: true |         collapsed:: true | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user