Skip to content

Commit c4ae4be

Browse files
committed
Remove duplicate information.
Users should check the JSON schema files instead
1 parent 480cfd1 commit c4ae4be

File tree

1 file changed

+0
-156
lines changed

1 file changed

+0
-156
lines changed

README.md

-156
Original file line numberDiff line numberDiff line change
@@ -29,162 +29,6 @@ script from /util/pre-commit.sh to /.git/hooks/pre-commit:
2929

3030
ln -s util/pre-commit.sh .git/hooks/pre-commit"
3131

32-
## The file system structure
33-
34-
The directory structure:
35-
36-
/pages
37-
$PATH_TO_PAGE (`blog/new-release-available-version-0.4.8` for example)
38-
content.md
39-
info.json
40-
... (images, etc.)
41-
...
42-
43-
/packages
44-
$PACKAGE_NAME (axr-browser, axr-core, etc.)
45-
release-$VERSION.json
46-
...
47-
...
48-
49-
/hssdoc
50-
@$OBJECT_NAME
51-
info.json
52-
property-$PROPERTY_NAME.json
53-
...
54-
...
55-
56-
wiki/
57-
$PATH_TO_PAGE (`developers/building` for example)
58-
content.md
59-
info.json
60-
... (images, etc.)
61-
...
62-
63-
config.json
64-
65-
### pages/.../info.json
66-
67-
{
68-
type: (string) type of the page. values: page|blog-post,
69-
title: (string) title for the page,
70-
file: (string) name of the content file. default: `content.md`,
71-
generate_toc: (boolean) auto-generate a table of contents,
72-
73-
Fields specific to `blog-post` type:
74-
date: (string) date in UTC in `YYYY-MM-DD` format (ISO 8601),
75-
authors: (string[]) list of the authors' real names,
76-
summary_file: (string) name of the file that contains the summary about
77-
the post. this file can reside in a subdirectory.
78-
}
79-
80-
Notes specific to `blog-post` type:
81-
- If no summary file is specified, you can insert `<!--more-->` anywhere in the
82-
content file and everything before that will be automatically used as the
83-
summary.
84-
- Blog posts don't currently support auto-generated tables of contents
85-
86-
### release-$VERSION.json
87-
88-
{
89-
package: (string) package name,
90-
version: (string) release version,
91-
files: [
92-
{
93-
os: (string) values: osx|linux|windows|src,
94-
arch: (string) values: x86_64|i386|intel|none,
95-
type: (string) values: msi|exe|dmg|deb|rpm|tar.gz,
96-
filename: (string),
97-
url: (string) absolute URL to the file,
98-
size: (int) file size in bytes,
99-
os_version_min: (string) minimum required version number.
100-
default: `null`,
101-
os_version_max: (string) maximum required version number.
102-
default: `null`,
103-
checksums: {
104-
md5: (string) MD5 checksum of the file,
105-
sha1: (string) SHA1 checksum of the file
106-
}
107-
},
108-
...
109-
]
110-
}
111-
112-
A valid version number is a string consisting of between 2 and 4 dot-separated
113-
integers. Example: `1.0.7`.
114-
115-
116-
### hssdoc/.../property-$PROPERTY_NAME.json
117-
118-
{
119-
name: (string) name of the property,
120-
readonly: (boolean) default: 0,
121-
many_values: (boolean) whether this property supports many values.
122-
this field is optional. default: 0,
123-
description_file: name of the content file. this field is optional,
124-
generate_toc: (boolean) auto-generate a table of contents,
125-
values: [
126-
{
127-
value: (string),
128-
is_default: (boolean) default: 0,
129-
since_version: (string) version of the core in which this
130-
value was implemented for this property. this field may
131-
be absent if the value has not been implemented,
132-
link_to: (string) format: `@OBJECT` or
133-
`@OBJECT<PROPERTY>` or `@OBJECT<PROPERTY>[VALUE]`
134-
},
135-
...
136-
],
137-
text_scope: [
138-
(string) values: "line", "word", "character"
139-
...
140-
]
141-
}
142-
143-
Note: The property name in the "name" field and in the file name must be
144-
identical.
145-
146-
Note: The `text_scope` field should only be used for properties that belong to
147-
the @text object.
148-
149-
### hssdoc/@$OBJECT_NAME/info.json
150-
151-
{
152-
name: (string) name of the object. for example: `@container`,
153-
owner: (string) name of the object. for example: `@container`. this
154-
field is optional,
155-
description_file: (string) name of the content file. this field is optional
156-
shorthand_stack: (array) properties in order [this field is optional]
157-
}
158-
159-
160-
### wiki/.../info.json
161-
162-
{
163-
title: (string) title of the page,
164-
file: (string) name of the content file. default: `content.md`
165-
}
166-
167-
168-
### config.json
169-
170-
This is a generic configuration file that is used by many different parts of the
171-
site.
172-
173-
{
174-
ga_account: (string) ID if the Google Analytics account,
175-
disqus_shortname: (string),
176-
social: {
177-
facebook: (string) Facebook username,
178-
github: (string) GitHub organization/user name,
179-
google_plus: (string) Google+ page ID,
180-
launchpad: (string) Launchpad ???,
181-
ohloh: (string) Ohloh profile name,
182-
twitter: (string) Twitter username, without the `@`,
183-
vimeo: (string) Vimeo username,
184-
youtube: (string) YouTube channel name
185-
}
186-
}
187-
18832
## Displaying pages
18933

19034
If a page is requested by URL `/about/features`, then the system will

0 commit comments

Comments
 (0)