Skip to content

Commit 665b497

Browse files
committed
Fix headers
1 parent 3c71f76 commit 665b497

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

scala3/scaladoc.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ The new Scala version 3 comes with a completely new implementation of the docume
77
In this article you can find highlights of new features that are or will be introduced to Scaladoc.
88
For general reference, visit [Scaladoc manual](https://dotty.epfl.ch/docs/usage/scaladoc/)
99

10-
# New features
10+
## New features
1111

12-
## Markdown syntax
12+
### Markdown syntax
1313

1414
The biggest change introduced in the new version of Scaladoc is the change of the default language for docstrings. So far Scaladoc only supported Wikidoc syntax.
1515
The new Scaladoc can still parse legacy `Wikidoc` syntax, however Markdown has been chosen as a primary language for formatting comments.
@@ -18,7 +18,7 @@ To switch back to `Wikidoc` one can pass a global flag before running the `doc`
1818
For more information on how to use the full power of docstings, check out [Scaladoc docstrings][scaladoc-docstrings]
1919

2020

21-
## Static site
21+
### Static site
2222

2323
Scaladoc also provides an easy way for creating **static sites** for both documentation and blog posts in the similar way as Jekyll does.
2424
Thanks to this feature, you can store your documentation along-side with the generated Scaladoc API in a very convenient way.
@@ -27,23 +27,23 @@ For more information on how to configure the generation of static sites check ou
2727

2828
![](../resources/images/scala3/scaladoc/static-site.png)
2929

30-
## Blog posts
30+
### Blog posts
3131

3232
Blog posts are a specific type of static sites. In the Scaladoc manual you can find additional information about how to work with [blog posts][built-in-blog].
3333

3434
![](../resources/images/scala3/scaladoc/blog-post.png)
3535

36-
## Social links
36+
### Social links
3737

3838
Furthermore, Scaladoc provides an easy way to configure your [social media links][social-links] e.g. Twitter or Gitter.
3939

4040
![](../resources/images/scala3/scaladoc/social-links.png){: style="width: 180px"}
4141

42-
# Experimental features
42+
## Experimental features
4343

4444
The following features are currently (May 2021) not stable to be released with scaladoc, however we are happy to hear your feedback. Each feature has its own thread at scala-lang contributors site, where you can share your opinions.
4545

46-
## Snippets compiler
46+
### Snippets compiler
4747

4848
One of the experimental features of Scaladoc will be a snippets compiler. This tool will allow you to compile snippets that you attach to your docstring
4949
to check that they actually behave as intended, e. g. compile or throw some exception. The feature is very similar to `tut` or `mdoc` tools,
@@ -54,7 +54,7 @@ For more information you can follow this [thread](https://contributors.scala-lan
5454
![](../resources/images/scala3/scaladoc/snippet-compiler2.gif)
5555
![](../resources/images/scala3/scaladoc/snippet-compiler1.gif)
5656

57-
## Inkuire (Hoogle-like searches)
57+
### Inkuire (Hoogle-like searches)
5858

5959
Haskell programmers are probably familiar with [Hoogle](https://hoogle.haskell.org/) - a documentation search engine that allows you to find functions by their signatures rather than their symbolic names. Since many Scala developers are also functional programming fans, we decided to add a similar functionality to Scaladoc.
6060

@@ -67,7 +67,6 @@ This feature is provided by [Inkuire](https://github.com/VirtusLab/Inkuire) sear
6767
Note that this feature is still in development, so it can be subject to considerable change.
6868
If You encounter a bug or have an idea for improvement don't hesitate to create an issue on [Inkuire](https://github.com/VirtusLab/Inkuire/issues/new) or [dotty](https://github.com/lampepfl/dotty/issues/new).
6969

70-
### How it works
7170

7271
Using this feature allows to find `def`s and `val`s from the documented code.
7372

0 commit comments

Comments
 (0)