You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Scala3doc is able to include a simple blog in your documentation. For now it provides only basic features in future we plan to include more advanced features like tagging or author pages.
7
+
Scala3doc allows you to include a simple blog in your documentation. For now, it
8
+
provides only basic features. In the future, we plan to include more advanced
Copy file name to clipboardExpand all lines: docs/docs/usage/scala3doc/index.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: Scala3doc
6
6
7
7
Scala3doc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` or `scaladoc` as well as `jekyll` or `docusaurus`.
8
8
9
-
As you probably guessed, this whole site was created using scala3doc.
9
+
As you probably have guessed, this whole site was created using Scala3doc.
10
10
11
11
12
12
{% for post in site.posts %}
@@ -22,5 +22,5 @@ As you probably guessed, this whole site was created using scala3doc.
22
22
23
23
We would love to have your feedback on what you think would be good in order to
24
24
render the documentation you want! Perhaps you would like to render method
25
-
definitions or members? Do you want to have runnable code samples? Let us know by filing
Copy file name to clipboardExpand all lines: docs/docs/usage/scala3doc/staticSite.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@ title: Static docucmentation
5
5
# {{ page.title}}
6
6
7
7
Scala3doc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
8
-
Having a combined tool allows to provide interaction between static documentation and API thus allowing the two to blend naturally.
8
+
Having a combined tool allows to provide interaction between static documentation and API, thus allowing the two to blend naturally.
9
9
10
10
Creating a site is just as simple as in Jekyll. The site root contains the
11
-
layout of the site and all files placed here will be either considered static,
11
+
layout of the site and all files placed there will be either considered static,
12
12
or processed for template expansion.
13
13
14
14
The files that are considered for template expansion must end in `*.{html,md}`
@@ -22,7 +22,7 @@ A simple "hello world" site could look something like this:
22
22
└── index.html
23
23
```
24
24
25
-
This will give you a site with the following files in genrated documentation:
25
+
This will give you a site with the following files in generated documentation:
26
26
27
27
```
28
28
index.html
@@ -40,20 +40,20 @@ documentation.
40
40
In Scala3doc, all templates can contain YAML front-matter. The front-matter
41
41
is parsed and put into the `page` variable available in templates via Liquid.
42
42
43
-
Scala3doc uses some predefied properties to controls some aspect of page.
43
+
Scala3doc uses some predefined properties to controls some aspect of page.
44
44
45
45
Predefined properties:
46
46
47
47
-**title** provide page title that will be used in navigation and html metadata.
48
-
-**extraCss** additional `.css` files that will be included in this page. Paths should be relative to documentation root. **This setting is not exported to template engine**
49
-
-**extraJs** additional `.js` files that will be included in this page. Paths should be relative to documentation root. **This setting is not exported to template engine**
50
-
-**hasFrame** when set to `false` page will not include default layout (navigation, breadcrumbs etc.) but only token html wrapper to provide metadata and resources (js and css files). **This setting is not exported to template engine**
51
-
-**layout** - predefined layout to use, see below. **This setting is not exported to template engine**
48
+
-**extraCss** additional `.css` files that will be included in this page. Paths should be relative to documentation root. **This setting is not exported to template engine.**
49
+
-**extraJs** additional `.js` files that will be included in this page. Paths should be relative to documentation root. **This setting is not exported to template engine.**
50
+
-**hasFrame** when set to `false` page will not include default layout (navigation, breadcrumbs etc.) but only token html wrapper to provide metadata and resources (js and css files). **This setting is not exported to template engine.**
51
+
-**layout** - predefined layout to use, see below. **This setting is not exported to template engine.**
52
52
53
53
54
54
## Using existing Templates and Layouts
55
55
56
-
To perform template expansion, Dottydoc looks at `layout` in the front-matter.
56
+
To perform template expansion, Dottydoc looks at the `layout` field in the front-matter.
57
57
Here's a simple example of the templating system in action, `index.html`:
58
58
59
59
```html
@@ -94,7 +94,7 @@ Layouts must be placed in a `_layouts` directory in the site root:
94
94
95
95
Sidebar
96
96
=======
97
-
Scala3doc by default use layout of files in `docs` directory to create table of content. There is also ability to override it by providing a `sidebar.yml` file in the site root:
97
+
Scala3doc by default uses layout of files in `docs` directory to create table of content. There is also ability to override it by providing a `sidebar.yml` file in the site root:
0 commit comments