m/dokytree
1
0
Fork 0
mirror of https://github.com/MatMoul/dokytree.git synced 2024-12-24 08:36:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
56fa5970af
dokytree/samples/doc_v1/doc/document/_index.01.md
MatMoul 56fa5970af Inital commit
2023-03-09 00:38:30 +01:00

1.4 KiB
Raw Blame History

Document is structured as nodes.
The doc object is the root node.
Nodes contains child nodes and items.

root
 |-nodes
 |  |-node
 |  |  |-nodes
 |  |  |  |-nodes
 |  |  |  |-items
 |  |  |-items
 |  |     |-item1
 |  |-node
 |     |-nodes
 |     |  |-nodes
 |     |  |-items
 |     |-items
 |        |-item1
 |-items

Node

node: {
	name: '',               // ReadOnly: File name
	title: '',              // Optional: Title (default: name)
	toc: true,              // Optional: Show in TOC (default: true)
	book: true,             // Optional: Include in Book (default: true)
	url: '/',               // ReadOnly: Node URL
	templates: {            // Optional
		node: '@node',        // Optional: Node template (default: @node)
		items: '@item',       // Optional: Items template (default: @item)
	},
	parent: null,           // ReadOnly: Parent node
	nodes: [],              // ReadOnly: Child nodes
	items: [],              // ReadOnly: Items
	getNode: (name) => {},  // Function: Get child node by name
	getItem: (name) => {},  // Function: Get item by name
}

Item

item: {
	name: '',      // Optional: Name
	title: '',     // Optional: Title (default: name)
	toc: false,    // Optional: Show in TOC (default: false)
	book: true,    // Optional: Include in Book (default: true)
	url: '',       // ReadOnly: Item URL
	data: {},      // ReadOnly: Item Data
}