Skip to content

Commit b41b87d

Browse files
WebFreak001WebFreak001
committed
replace everything with material docs
fix #53, fix #49, fix #12
1 parent 29b51e0 commit b41b87d

File tree

108 files changed

+8248
-6256
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+8248
-6256
lines changed

‎.editorconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
root = true
22

3-
[*.{c,css,h,d,di,dd,dt,js,json}]
3+
[*.md]
44
end_of_line = lf
55
insert_final_newline = true
6-
indent_style = tab
6+
indent_style = space
77
indent_size = 4
88
trim_trailing_whitespace = true
99
charset = utf-8

‎.gitignore

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
1-
/.project
2-
/.dub
3-
/__test__library__
4-
/dub-docs
5-
*.exe
6-
log.txt
7-
settings.json
1+
site/

‎README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,32 @@ Documentation for [dub](https://github.com/dlang/dub/) packages, see <https://du
55

66
For the package registry, see https://code.dlang.org
77

8-
How to build & run locally
9-
--------------------------
8+
## Contributing
9+
10+
The documentation should be written using clear english, preferably avoiding addressing the reader with `"you"`, but rather using the passive form.
11+
12+
The "dub-guide" folder (called DUB Guide) should contain quick summaries for the experienced user to quickly look up features, but also for the casual user to understand how most things work. Explanation should be kept short and concise. Whenever there are things that might not be completely clear, example images, CLI output or full project file structures should be provided.
13+
14+
The "dub-reference" folder (called DUB Reference) should contain everything there is to know about DUB for the user. Everything should try to contain example recipes, example code, example output, so users know what to expect using things.
15+
16+
Try not to duplicate information from the guide and the reference, but rather give short summaries in the guide and link to the reference for more in-depth explanation.
17+
18+
The CLI reference is auto-generated and can be improved by improving the man page generator in the DUB project. (currently the markdown output is not yet PRd / merged into master there, so try to wait a little bit for this first)
19+
20+
The intro pages should show everything to get started and not much more, to not overwhelm the user.
21+
22+
### Local development
23+
24+
To work on docs locally:
1025

1126
```
12-
dub
27+
# you might want to create a virtualenv if you work with python or other mkdocs sites a lot
28+
python3 -m pip install -r requirements.txt
29+
mkdocs serve
1330
```
1431

15-
Pages
16-
-----
17-
Documentation under `views/` is written in `diet-ng` template format,
18-
see https://code.dlang.org/packages/diet-ng.
32+
and to build static pages to distribute:
33+
34+
```
35+
mkdocs build
36+
```

‎docs/cli-reference/dub-add-local.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# dub-add-local(1)
2+
dub-add-local \- Adds a local package directory (e.g. a git repository)
3+
## SYNOPSIS
4+
<b>dub add-local </b>&lt;<i>path</i>&gt; [&lt;<i>version</i>&gt;] <i>OPTIONS...</i>
5+
## DESCRIPTION
6+
Adds a local package directory to be used during dependency resolution. This command is useful for registering local packages, such as GIT working copies, that are either not available in the package registry, or are supposed to be overwritten.
7+
8+
9+
10+
The version of the package is either determined automatically (see the "add-path" command, or can be explicitly overwritten by passing a version on the command line.
11+
12+
13+
14+
See 'dub add-path -h' for a way to register multiple local packages at once.
15+
## OPTIONS
16+
17+
<dl>
18+
19+
20+
<dt id="option-add-local---b---system-b-" class="option-argname">
21+
<a class="anchor" href="#option-add-local---b---system-b-"></a>
22+
23+
<b>--system</b>
24+
25+
</dt>
26+
27+
28+
<dd markdown="1" class="option-desc">
29+
30+
Register system-wide instead of user-wide
31+
32+
</dd>
33+
34+
35+
</dl>
36+
37+
### COMMON OPTIONS
38+
See [<b>dub</b>(1)](dub.md)
39+
## EXIT STATUS
40+
41+
<dl markdown="1">
42+
43+
<dt markdown="1">
44+
45+
<b>0</b>
46+
47+
</dt>
48+
<dd markdown="1">
49+
50+
DUB succeeded
51+
52+
</dd>
53+
<dt markdown="1">
54+
55+
<b>1</b>
56+
57+
</dt>
58+
<dd markdown="1">
59+
60+
usage errors, unknown command line flags
61+
62+
</dd>
63+
<dt markdown="1">
64+
65+
<b>2</b>
66+
67+
</dt>
68+
<dd markdown="1">
69+
70+
package not found, package failed to load, miscellaneous error
71+
72+
</dd>
73+
74+
</dl>
75+
76+
## FILES
77+
<i>dub.sdl</i>, <i>dub.json</i>
78+
## AUTHOR
79+
Copyright (c) 1999-2022 by The D Language Foundation
80+
## ONLINE DOCUMENTATION
81+
[http://code.dlang.org/docs/commandline](http://code.dlang.org/docs/commandline)
82+
## SEE ALSO
83+
[<b>dub</b>(1)](dub.md), [<b>dub-remove-local</b>(1)](dub-remove-local.md)

‎docs/cli-reference/dub-add-override.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# dub-add-override(1)
2+
dub-add-override \- Adds a new package override.
3+
## SYNOPSIS
4+
<b>dub add-override </b>&lt;<i>package</i>&gt; &lt;<i>version-spec</i>&gt; &lt;<i>target-path/target-version</i>&gt; <i>OPTIONS...</i>
5+
## DESCRIPTION
6+
7+
## OPTIONS
8+
9+
<dl>
10+
11+
12+
<dt id="option-add-override---b---system-b-" class="option-argname">
13+
<a class="anchor" href="#option-add-override---b---system-b-"></a>
14+
15+
<b>--system</b>
16+
17+
</dt>
18+
19+
20+
<dd markdown="1" class="option-desc">
21+
22+
Register system-wide instead of user-wide
23+
24+
</dd>
25+
26+
27+
</dl>
28+
29+
### COMMON OPTIONS
30+
See [<b>dub</b>(1)](dub.md)
31+
## EXIT STATUS
32+
33+
<dl markdown="1">
34+
35+
<dt markdown="1">
36+
37+
<b>0</b>
38+
39+
</dt>
40+
<dd markdown="1">
41+
42+
DUB succeeded
43+
44+
</dd>
45+
<dt markdown="1">
46+
47+
<b>1</b>
48+
49+
</dt>
50+
<dd markdown="1">
51+
52+
usage errors, unknown command line flags
53+
54+
</dd>
55+
<dt markdown="1">
56+
57+
<b>2</b>
58+
59+
</dt>
60+
<dd markdown="1">
61+
62+
package not found, package failed to load, miscellaneous error
63+
64+
</dd>
65+
66+
</dl>
67+
68+
## FILES
69+
<i>dub.sdl</i>, <i>dub.json</i>
70+
## AUTHOR
71+
Copyright (c) 1999-2022 by The D Language Foundation
72+
## ONLINE DOCUMENTATION
73+
[http://code.dlang.org/docs/commandline](http://code.dlang.org/docs/commandline)
74+
## SEE ALSO
75+
[<b>dub</b>(1)](dub.md), [<b>dub-list-overrides</b>(1)](dub-list-overrides.md), [<b>dub-remove-override</b>(1)](dub-remove-override.md)

‎docs/cli-reference/dub-add-path.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# dub-add-path(1)
2+
dub-add-path \- Adds a default package search path
3+
## SYNOPSIS
4+
<b>dub add-path </b>&lt;<i>path</i>&gt; <i>OPTIONS...</i>
5+
## DESCRIPTION
6+
Adds a default package search path. All direct sub folders of this path will be searched for package descriptions and will be made available as packages. Using this command has the equivalent effect as calling 'dub add-local' on each of the sub folders manually.
7+
8+
9+
10+
Any packages registered using add-path will be preferred over packages downloaded from the package registry when searching for dependencies during a build operation.
11+
12+
13+
14+
The version of the packages will be determined by one of the following:
15+
16+
- For GIT working copies, the last tag (git describe) is used to determine the version
17+
18+
- If the package contains a "version" field in the package description, this is used
19+
20+
- If neither of those apply, "~master" is assumed
21+
## OPTIONS
22+
23+
<dl>
24+
25+
26+
<dt id="option-add-path---b---system-b-" class="option-argname">
27+
<a class="anchor" href="#option-add-path---b---system-b-"></a>
28+
29+
<b>--system</b>
30+
31+
</dt>
32+
33+
34+
<dd markdown="1" class="option-desc">
35+
36+
Register system-wide instead of user-wide
37+
38+
</dd>
39+
40+
41+
</dl>
42+
43+
### COMMON OPTIONS
44+
See [<b>dub</b>(1)](dub.md)
45+
## EXIT STATUS
46+
47+
<dl markdown="1">
48+
49+
<dt markdown="1">
50+
51+
<b>0</b>
52+
53+
</dt>
54+
<dd markdown="1">
55+
56+
DUB succeeded
57+
58+
</dd>
59+
<dt markdown="1">
60+
61+
<b>1</b>
62+
63+
</dt>
64+
<dd markdown="1">
65+
66+
usage errors, unknown command line flags
67+
68+
</dd>
69+
<dt markdown="1">
70+
71+
<b>2</b>
72+
73+
</dt>
74+
<dd markdown="1">
75+
76+
package not found, package failed to load, miscellaneous error
77+
78+
</dd>
79+
80+
</dl>
81+
82+
## FILES
83+
<i>dub.sdl</i>, <i>dub.json</i>
84+
## AUTHOR
85+
Copyright (c) 1999-2022 by The D Language Foundation
86+
## ONLINE DOCUMENTATION
87+
[http://code.dlang.org/docs/commandline](http://code.dlang.org/docs/commandline)
88+
## SEE ALSO
89+
[<b>dub</b>(1)](dub.md), [<b>dub-remove-path</b>(1)](dub-remove-path.md)

‎docs/cli-reference/dub-add.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# dub-add(1)
2+
dub-add \- Adds dependencies to the package file.
3+
## SYNOPSIS
4+
<b>dub add </b>&lt;<i>package</i>&gt;[@&lt;<i>version-spec</i>&gt;] [&lt;<i>packages...</i>&gt;] <i>OPTIONS...</i>
5+
## DESCRIPTION
6+
Adds &lt;packages&gt; as dependencies.
7+
8+
9+
10+
Running "dub add &lt;package&gt;" is the same as adding &lt;package&gt; to the "dependencies" section in dub.json/dub.sdl.
11+
12+
If no version is specified for one of the packages, dub will query the registry for the latest version.
13+
## OPTIONS
14+
15+
<dl>
16+
17+
18+
</dl>
19+
20+
### COMMON OPTIONS
21+
See [<b>dub</b>(1)](dub.md)
22+
## EXIT STATUS
23+
24+
<dl markdown="1">
25+
26+
<dt markdown="1">
27+
28+
<b>0</b>
29+
30+
</dt>
31+
<dd markdown="1">
32+
33+
DUB succeeded
34+
35+
</dd>
36+
<dt markdown="1">
37+
38+
<b>1</b>
39+
40+
</dt>
41+
<dd markdown="1">
42+
43+
usage errors, unknown command line flags
44+
45+
</dd>
46+
<dt markdown="1">
47+
48+
<b>2</b>
49+
50+
</dt>
51+
<dd markdown="1">
52+
53+
package not found, package failed to load, miscellaneous error
54+
55+
</dd>
56+
57+
</dl>
58+
59+
## FILES
60+
<i>dub.sdl</i>, <i>dub.json</i>
61+
## AUTHOR
62+
Copyright (c) 1999-2022 by The D Language Foundation
63+
## ONLINE DOCUMENTATION
64+
[http://code.dlang.org/docs/commandline](http://code.dlang.org/docs/commandline)
65+
## SEE ALSO
66+
[<b>dub</b>(1)](dub.md), [<b>dub-convert</b>(1)](dub-convert.md), [<b>dub-fetch</b>(1)](dub-fetch.md), [<b>dub-init</b>(1)](dub-init.md)

0 commit comments

Comments
 (0)