@paroicms/site-generator-plugin 0.8.1 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -6,4 +6,6 @@ A document always has the following base attributes: a localized _title_, a _pub
|
|
|
6
6
|
|
|
7
7
|
A document can contain lists of **parts**. A _part_ is a sub-section of a document, or of another _part_. A part always has a _publish date_ and a _draft_ flag. It may contain a sequence of fields and/or a sequence of child parts. A part is always an item of a list.
|
|
8
8
|
|
|
9
|
-
Any routing document which is parent of regular documents can be used as a **taxonomy**. Then, the terms are the regular child documents. Then a taxonomy can be used in any document or part, by declaring a **labeling field**.
|
|
9
|
+
Any routing document which is parent of regular documents can be used as a **taxonomy**. Then, the terms are the regular child documents. Then a taxonomy can be used in any document or part, by declaring a **labeling field**.
|
|
10
|
+
|
|
11
|
+
Documents and parts are **nodes** in a tree. Children are part of the definition of a node type. When 2 node types appear identical, but their children types are not the same, then they are 2 different node types and they should have 2 different names.
|
|
@@ -30,16 +30,17 @@ For this second step, follow these instructions for creating the bullet list:
|
|
|
30
30
|
|
|
31
31
|
1. Carefully read and analyze the website description.
|
|
32
32
|
2. Identify the main documents and parts of the website.
|
|
33
|
-
- Notice: Children are part of the definition of a node type. When 2 node types appear identical, but their children types are not the same, then they are 2 different node types and they should have 2 different names.
|
|
34
33
|
3. Determine the hierarchical relationships between documents and parts.
|
|
35
34
|
4. Create a tree structure using a limited Markdown format to represent the website's tree structure.
|
|
36
35
|
|
|
36
|
+
Whenever you have a choice, keep it simple. If the user is not directive, if he gives a general and vague instruction, for example with a short prompt like “create a blog”, then limit the site sections to two main entries (in the example of a blog, a list of posts and a list of pages). Plus the usual contact and search pages.
|
|
37
|
+
|
|
37
38
|
Guidelines for creating the hierarchical bullet list:
|
|
38
39
|
|
|
39
40
|
- Write in English.
|
|
40
41
|
- But, if the website description is not in English: do not translate book or post titles.
|
|
41
42
|
- Use a Markdown syntax. Indent with 2 spaces. Use indentation to show parent-child relationships between node types.
|
|
42
|
-
- Always
|
|
43
|
+
- Always start with the homepage, with key `home` at the top level.
|
|
43
44
|
- When you define an identifier for a node type name or a list name, use camel case and follow the identifier syntax of JavaScript.
|
|
44
45
|
- Use `contactPage` as the default type name for contact page, and `searchPage` for the search page.
|
|
45
46
|
- Bullet point format for a _routing document_:
|