Add basic documentation

Author: romanowski

docs/docs/usage/dottydoc.md

@@ -1,6 +1,6 @@
 ---
 layout: doc-page
-title: Dottydoc
+title: Dottydoc [Legacy]
 ---
 
 Dottydoc is a tool to generate a combined documentation and API reference for

docs/docs/usage/scala3doc/blog.md

@@ -0,0 +1,7 @@
+---
+title: Build-in blog
+---
+
+# {{page.title}}
+
+Scala3doc is capable to include blogposts. For now we support only simple blogposts but in future we plan to include more advanced features like tags.

docs/docs/usage/scala3doc/docComments.md

@@ -0,0 +1,7 @@
+---
+title: API Documentation
+---
+
+# {{ page.title }}
+
+Scala3doc main feature is to create API documentation based on [doc comments](https://docs.scala-lang.org/style/scaladoc.html) known from scaladoc as well well as new syntax introduced in Scala 3.

docs/docs/usage/scala3doc/index.md

@@ -0,0 +1,24 @@
+---
+title: Scala3doc
+---
+
+![Scala3doc logo](/images/scala3doc-logo.png)
+
+Scala3doc is a doctool dedicated to work with Scala 3.0. Beside basic features similar to `javadoc` or `scaladoc`. As you probably guessed, this
+whole site was created using scala3doc.
+
+{% for post in site.posts %}
+## [{{ post.title }}](/{{ post.url }})
+
+{{ post.excerpt }}
+
+[ (read more) ](/{{ post.url }})
+
+{% endfor %}
+
+## Other extensions
+
+We would love to have your feedback on what you think would be good in order to
+render the documentation you want! Perhaps you would like to render method
+definitions or members? Let us know by filing
+[issues](https://github.com/lampepfl/dotty/issues/new)!

docs/docs/usage/scala3doc/specificTags.md

@@ -0,0 +1,29 @@
+---
+title: Dottydoc Specific Tags and Behavior
+---
+
+# {{page.title}}
+
+Scala3doc extemds markdown with some unique behaviours such as linking to API. This can be used from within static documentation and blogpost to provide blend-in content.
+
+## Linking to API
+
+If you for instance, want to link to `scala.collection.immutable.Seq` in a
+markdown file, you can simply use the canonical path in your url:
+
+```markdown
+[Seq](scala.collection.immutable.Seq)
+```
+
+Linking to members is done in the same fashion:
+
+```markdown
+[Seq](scala.collection.immutable.Seq.isEmpty)
+```
+
+Scala3doc denotes objects by ending their names in "$". To select `List.range`
+you'd therefore write:
+
+```markdown
+[List.range](scala.collection.immutable.List$.range)
+```

docs/docs/usage/scala3doc/staticSite.md

@@ -0,0 +1,125 @@
+---
+title: Static docucmentation
+---
+
+# {{ page.title}}
+
+Scala3doc has similar functionalites to [Jekyll](http://jekyllrb.com/) to allow users to documentation in form of static sit alongside your APIs. Moreover having a combined tool allows provide reach interaction between those to such as linking thus allowing the two to
+blend naturally.
+
+Creating a site is just as simple as in Jekyll. The site root contains the
+layout of the site and all files placed here will be either considered static,
+or processed for template expansion.
+
+The files that are considered for template expansion must end in `*.{html,md}`
+and will from here on be referred to as "template files" or "templates".
+
+A simple "hello world" site could look something like this:
+
+```
+├── docs
+│   └── getting-started.md
+└── index.html
+```
+
+This will give you a site with the following files in genrated documentation:
+
+```
+index.html
+docs/getting-started.html
+```
+
+Scala3doc 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)).
+
+## Properties
+
+Scala3doc uses the [Liquid](https://shopify.github.io/liquid/) templating engine
+and provides a number of custom filters and tags specific to Scala
+documentation.
+
+In Scala3doc, all templates can contain YAML front-matter. The front-matter
+is parsed and put into the `page` variable available in templates via Liquid.
+
+Scala3doc uses some predefied properties to controls some aspect of page.
+
+Predefiend properties:
+
+ - **title** provide page title that will be used in navigation and html metadata.
+ - **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**
+ - **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**
+ - **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)
+- **layout** - predefined layout to use, see below
+
+
+## Using existing Templates and Layouts
+
+To perform template expansion, Dottydoc looks at `layout` in the front-matter.
+Here's a simple example of the templating system in action, `index.html`:
+
+```html
+---
+layout: main
+---
+
+<h1>Hello world!</h1>
+```
+
+With a simple main template like this:
+
+{% raw %}
+```html
+<html>
+    <head>
+        <title>Hello, world!</title>
+    </head>
+    <body>
+        {{ content }}
+    </body>
+</html>
+```
+
+Would result in `{{ content }}` being replaced by `<h1>Hello world!</h1>` from
+the `index.html` file.
+{% endraw %}
+
+Layouts must be placed in a `_layouts` directory in the site root:
+
+```
+├── _layouts
+│   └── main.html
+├── docs
+│   └── getting-started.md
+└── index.html
+```
+
+Sidebar
+=======
+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:
+
+```yaml
+sidebar:
+    - title: Blog
+      url: blog/index.html
+    - title: Docs
+      url: docs/index.html
+    - title: Usage
+      subsection:
+        - title: Dottydoc
+          url: docs/usage/dottydoc.html
+        - title: sbt-projects
+          url: docs/usage/sbt-projects.html
+```
+
+The `sidebar` key is mandatory, as well as `title` for each element. The
+default table of contents allows you to have subsections - albeit the current
+depth limit is 2 however it accepts both files and directories and latter can be used to provide deeper structures.
+
+The items which have the `subsection` does not accepts `url` section.
+
+```
+├── blog
+│   └── _posts
+│       └── 2016-12-05-implicit-function-types.md
+├── index.html
+└── sidebar.yml
+```

docs/images/scala3doc-logo.png

@@ -15,7 +15,9 @@ sidebar:
           url: docs/usage/language-versions.html
         - title: cbt-projects
           url: docs/usage/cbt-projects.html
-        - title: Dottydoc
+        - title: Scala3doc
+          url: docs/usage/scala3doc
+        - title: Dottydoc [Legacy]
           url: docs/usage/dottydoc.html
     - title: Reference
       subsection: