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
Copy file name to clipboardExpand all lines: docs/blog/_posts/2020-12-18-scala3-m3.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,9 +133,9 @@ You can read the discussion of this change in the [PR #10670](https://github.com
133
133
# Tooling improvements
134
134
As we are getting closer to a stable release of Scala 3, the focus increasingly shifts on the tooling available to get started with Scala 3.
135
135
136
-
For a while now, we are not using the old dottydoc documentation tool for building the documentation. We are developing an entirely new tool, scaladoc, from scratch. This new documentation tool is more robust and faster than the old one.
136
+
For a while now, we are not using the old dottydoc documentation tool for building the documentation. We are developing an entirely new tool, scala3doc, from scratch. This new documentation tool is more robust and faster than the old one.
137
137
138
-
As part of the tooling effort, this new Scala 3 documentation tool is rapidly improved. [PR #10522](https://github.com/lampepfl/dotty/pull/10522) proves that the doctool can generate documentation for the community build projects. You can access this documentation via the following [link](https://scaladoc.virtuslab.com/pr-master-docs/index.html).
138
+
As part of the tooling effort, this new Scala 3 documentation tool is rapidly improved. [PR #10522](https://github.com/lampepfl/dotty/pull/10522) proves that the doctool can generate documentation for the community build projects. You can access this documentation via the following [link](https://scala3doc.virtuslab.com/pr-master-docs/index.html).
139
139
140
140
[PR #10491](https://github.com/lampepfl/dotty/pull/10491) introduced scripting support in Scala 3. Consider the following source named `Main.scala`:
Copy file name to clipboardExpand all lines: docs/docs/usage/scaladoc/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: scaladoc
4
4
5
5

6
6
7
-
scaladoc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc`or `scaladoc`as well as `jekyll` or `docusaurus`.
7
+
scaladoc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` as well as `jekyll` or `docusaurus`.
8
8
9
9
As you probably have guessed, this whole site was created using scaladoc.
Copy file name to clipboardExpand all lines: docs/docs/usage/scaladoc/staticSite.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Static documentation
4
4
5
5
# {{ page.title}}
6
6
7
-
scaladoc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
7
+
Scaladoc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
8
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
@@ -29,18 +29,18 @@ index.html
29
29
docs/getting-started.html
30
30
```
31
31
32
-
scaladoc can transform both files and directories (to organize your documentation into tree-like structure). By default directories has title based on file name and has empty content. There is an option to include `index.html` or `index.md` (not both) to provide both content and properties like title (see [Properties](#properties)).
32
+
Scaladoc can transform both files and directories (to organize your documentation into tree-like structure). By default directories has title based on file name and has empty content. There is an option to include `index.html` or `index.md` (not both) to provide both content and properties like title (see [Properties](#properties)).
33
33
34
34
## Properties
35
35
36
-
scaladoc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
36
+
Scaladoc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
37
37
and provides a number of custom filters and tags specific to Scala
38
38
documentation.
39
39
40
-
In scaladoc, all templates can contain YAML front-matter. The front-matter
40
+
In Scaladoc, 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
-
scaladoc uses some predefined properties to controls some aspect of page.
43
+
Scaladoc uses some predefined properties to controls some aspect of page.
44
44
45
45
Predefined properties:
46
46
@@ -94,7 +94,7 @@ Layouts must be placed in a `_layouts` directory in the site root:
94
94
95
95
Sidebar
96
96
=======
97
-
scaladoc 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:
97
+
Scaladoc 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