Skip to content

Commit d3698ee

Browse files
committed
Scala3doc: improve docs
1 parent 25f5e08 commit d3698ee

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

docs/docs/usage/scala3doc/blog.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: Build-in blog
2+
title: Built-in blog
33
---
44

55
# {{page.title}}
66

7-
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
9+
features like tagging or author pages.

docs/docs/usage/scala3doc/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Scala3doc
66

77
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`.
88

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.
1010

1111

1212
{% for post in site.posts %}
@@ -22,5 +22,5 @@ As you probably guessed, this whole site was created using scala3doc.
2222

2323
We would love to have your feedback on what you think would be good in order to
2424
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
26-
[issues](https://github.com/lampepfl/dotty/issues/new)!
25+
definitions or members? Do you want to have runnable code snippets? Let us know
26+
by filing [issues](https://github.com/lampepfl/dotty/issues/new)!

docs/docs/usage/scala3doc/staticSite.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ title: Static docucmentation
55
# {{ page.title}}
66

77
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.
99

1010
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,
1212
or processed for template expansion.
1313

1414
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:
2222
└── index.html
2323
```
2424

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:
2626

2727
```
2828
index.html
@@ -40,20 +40,20 @@ documentation.
4040
In Scala3doc, all templates can contain YAML front-matter. The front-matter
4141
is parsed and put into the `page` variable available in templates via Liquid.
4242

43-
Scala3doc uses some predefied properties to controls some aspect of page.
43+
Scala3doc uses some predefined properties to controls some aspect of page.
4444

4545
Predefined properties:
4646

4747
- **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.**
5252

5353

5454
## Using existing Templates and Layouts
5555

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.
5757
Here's a simple example of the templating system in action, `index.html`:
5858

5959
```html
@@ -94,7 +94,7 @@ Layouts must be placed in a `_layouts` directory in the site root:
9494

9595
Sidebar
9696
=======
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:
9898

9999
```yaml
100100
sidebar:

0 commit comments

Comments
 (0)