Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to Docusaurus 2.0 #2927

Merged
merged 3 commits into from Jul 6, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Expand Up @@ -46,6 +46,8 @@ website/yarn.lock
website/node_modules
website/i18n/*
!website/i18n/en.json
website/.docusaurus
website/.cache-loader

project/metals.sbt
coursier
3 changes: 1 addition & 2 deletions docs/editors/overview.md
Expand Up @@ -2,6 +2,7 @@
id: overview
title: Text Editors
sidebar_label: Overview
slug: /
---

## Latest Metals server versions
Expand All @@ -13,7 +14,6 @@ specific sections.

```


ckipp01 marked this conversation as resolved.
Show resolved Hide resolved
## Editor support

Metals works with the following text editors with varying degree of
Expand Down Expand Up @@ -127,7 +127,6 @@ functionality.
<td align="center">✅</td>
<td align="center">✅</td>
</tr>
</tr>
<tr>
<td>Worksheets</td>
<td align="center">✅</td>
Expand Down
1 change: 1 addition & 0 deletions docs/editors/vim.md
@@ -1,5 +1,6 @@
---
id: vim
sidebar_label: Vim
title: Vim
---

Expand Down
4 changes: 1 addition & 3 deletions docs/editors/vscode.md
@@ -1,13 +1,11 @@
---
id: vscode
sidebar_label: VS Code
title: Visual Studio Code
---

![Goto Definition](https://user-images.githubusercontent.com/1408093/48776422-1f764f00-ecd0-11e8-96d1-170f2354d50e.gif)

```scala mdoc:requirements
ckipp01 marked this conversation as resolved.
Show resolved Hide resolved

```

## Installation

Expand Down
14 changes: 9 additions & 5 deletions metals-docs/src/main/scala/docs/Docs.scala
Expand Up @@ -10,9 +10,11 @@ object Docs {
def releasesResolverTable: String = {
<table>
<thead>
<th>Version</th>
<th>Published</th>
<th>Resolver</th>
<tr>
<th>Version</th>
<th>Published</th>
<th>Resolver</th>
</tr>
</thead>
<tbody>
<tr>
Expand All @@ -32,8 +34,10 @@ object Docs {
def releasesTable: String = {
<table>
<thead>
<th>Version</th>
<th>Published</th>
<tr>
<th>Version</th>
<th>Published</th>
</tr>
</thead>
<tbody>
<tr>
Expand Down
9 changes: 1 addition & 8 deletions website/blog/2018-12-12-fast-goto-definition.md
Expand Up @@ -21,13 +21,6 @@ the result on a real-world project.
The work presented in this post was done as part of my job at the
[Scala Center](https://scala.epfl.ch/).

<style>
blockquote {
background-color: rgba(100, 205, 255, 0.3);
border-left: 8px solid #64cdff;
}
</style>

## Problem statement

What happens when you run Goto Definition? In reality, a lot goes on but in this
Expand Down Expand Up @@ -201,7 +194,7 @@ evaluate how our indexer performs in the real world, we test Metals on the
Scala that replaces traditional ORMs and data access layers with a universal
database abstraction.

<img width="998" alt="prisma" src="https://user-images.githubusercontent.com/1408093/49875321-08cf9d80-fe21-11e8-9f02-54ff4960a7af.png">
![prisma](https://user-images.githubusercontent.com/1408093/49875321-08cf9d80-fe21-11e8-9f02-54ff4960a7af.png)

The project has around 80k lines of Scala code.

Expand Down
15 changes: 2 additions & 13 deletions website/blog/2019-01-22-bloom-filters.md
Expand Up @@ -24,13 +24,6 @@ filters. Finally, we evaluate these new features on a real-world project: the
The work presented in this post was done as part of my job at the
[Scala Center](https://scala.epfl.ch/).

<style>
blockquote {
background-color: rgba(100, 205, 255, 0.3);
border-left: 8px solid #64cdff;
}
</style>

## Bloom filters

[Bloom filters](https://en.wikipedia.org/wiki/Bloom_filter) are a probabilistic
Expand Down Expand Up @@ -363,9 +356,7 @@ bottle-neck appears to be starting the file watcher and parsing all `*.scala`
and `*.java` sources in the workspace. The following flamegraph shows a detailed
breakdown of what goes on during indexing.

<a href="https://geirsson.com/assets/metals-akka-initialize.svg" target="_blank">
<img src="https://i.imgur.com/Xhr1wXp.jpg" alt="Akka indexing flamegraph">
</a>
![Akka indexing flamegraph](https://i.imgur.com/Xhr1wXp.jpg)(https://geirsson.com/assets/metals-akka-initialize.svg)

> Click on image to interactively explore the flamegraph.

Expand All @@ -382,9 +373,7 @@ the distribution is different for how long each indexing task takes. Prisma has
fewer sources (80k lines of Scala code, no Java) and a larger number of library
dependencies compared to Akka.

<a href="https://geirsson.com/assets/metals-prisma-initialize.svg" target="_blank">
<img src="https://i.imgur.com/JR3SNx6.jpg" alt="Prisma indexing flamegraph">
</a>
![Prisma indexing flamegraph](https://i.imgur.com/JR3SNx6.jpg)(https://geirsson.com/assets/metals-prisma-initialize.svg)

> Click on image to interactively explore the flamegraph.

Expand Down
2 changes: 1 addition & 1 deletion website/blog/2019-06-28-thorium.md
Expand Up @@ -67,7 +67,7 @@ only a single compilation progress was reported through the status bar.

### Help and feedback explorer

<img width="295" alt="Screenshot 2019-06-27 at 15 57 15" src="https://user-images.githubusercontent.com/1408093/60277560-1ef50500-98fe-11e9-8c02-70b841a590c3.png">
<img width="295" alt="Screenshot 2019-06-27 at 15 57 15" src="https://user-images.githubusercontent.com/1408093/60277560-1ef50500-98fe-11e9-8c02-70b841a590c3.png"/>

## Support for Scala 2.13

Expand Down
2 changes: 1 addition & 1 deletion website/blog/2020-04-10-cobalt.md
Expand Up @@ -134,7 +134,7 @@ identically named classes in different modules. A uri will be returned that can
be used by the DAP client.

More information about adding support for debugging is available
[here](/metals/docs/editors/debug-adapter-protocol.html).
[here](/metals/docs/integrations/debug-adapter-protocol).

This awesome new feature was contributed by
[alekseiAlefirov](https://github.com/alekseiAlefirov) from VirtusLab.
Expand Down
4 changes: 2 additions & 2 deletions website/blog/2020-08-19-lithium.md
Expand Up @@ -56,9 +56,9 @@ give Metals a try!
Thanks to the great work by [dos65](https://github.com/dos65) Metals now
supports sbt script files as well as build's Scala files. The full list of
currently supported features is available
[here](/metals/docs/editors/overview.html#additional-file-types).
[here](/metals/docs#additional-file-types).

sbt support is is achived by generating additional `metals.sbt` file for each
sbt support is is achieved by generating additional `metals.sbt` file for each
level of sbt's project. For `build.sbt` we now generate
`project/project/metals.sbt`, for `project/other.sbt`
`project/project/project/metals.sbt` etc. This is needed for the Bloop plugin to
Expand Down
6 changes: 3 additions & 3 deletions website/blog/2020-11-20-lithium.md
Expand Up @@ -55,7 +55,7 @@ give Metals a try!
## Show implicit conversions and classes

Last
[release](/metals/blog/2020/11/10/lithium.html#show-implicits-and-type-decorations)
[release](/metals/blog/2020/11/10/lithium#show-implicits-and-type-decorations)
introduced the option to display additional data inferred from the code to a
user. Starting with this release it's also possible to show implicit conversions
and classes, which can be enabled by the additional
Expand All @@ -75,7 +75,7 @@ changing any of those settings.

Previously, it was possible to navigate a stacktrace using the
`Analyze stacktrace` command which was added in the
[v0.9.4](/metals/blog/2020/09/21/lithium.html#analyze-stacktrace-command)
[v0.9.4](/metals/blog/2020/09/21/lithium#analyze-stacktrace-command)
release. It turns out, we can reuse the same mechanism to show file links in the
`Debug Console` in Visual Studio code:

Expand All @@ -88,7 +88,7 @@ clients.
## Troubleshooting

As an addition to these new features, we've also recently added a new
[troubleshooting page](/metals/docs/troubleshooting/faq.html) that should answer
[troubleshooting page](/metals/docs/troubleshooting/faq) that should answer
the most basic questions you can have. As the page is fairly new we would appreciate
any help in improving it so let us know if you feel anything is missing.

Expand Down
71 changes: 0 additions & 71 deletions website/core/Footer.js

This file was deleted.