Upgrade to Docusaurus v3

Author: alphaville

.gitignore

@@ -43,6 +43,7 @@ open-clib/Cargo.lock
 /website/node_modules/
 /website/yarn.lock
 /website/build/
+/website/.docusaurus/
 !/website/pages/
 !/website/static/
 !/website/*.js
@@ -73,4 +74,4 @@ open-clib/Cargo.lock
 *private*
 .DS_Store
 /img/
-private/
+private/

docs/example-nmpc.md

@@ -2,7 +2,7 @@
 id: example-nmpc
 title: Control of population dynamics
 sidebar_label: Population dynamics
-description: Nonlinear model predictive control with OpEn: population dynamics
+description: "Nonlinear model predictive control with OpEn: population dynamics"
 ---
 <script type="text/x-mathjax-config">MathJax.Hub.Config({tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}});</script>
 <script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

docs/example_bnp_py.md

@@ -214,7 +214,7 @@ builder.build()
 ```
 
 This will generate a solver in Rust as well as a [TCP server](./python-tcp-ip) that will 
-listen for requests at `localhost:8333` (this [can be configured](python-advanced#tcp-ip-interface)).
+listen for requests at `localhost:8333` (this [can be configured](python-advanced#tcpip-interface)).
 
 
 

docs/example_tanks_py.md

@@ -221,7 +221,7 @@ builder.build()
 ```
 
 This will generate a solver in Rust as well as a [TCP server](./python-tcp-ip) that will 
-listen for requests at `localhost:8333` (this [can be configured](python-advanced#tcp-ip-interface)).
+listen for requests at `localhost:8333` (this [can be configured](python-advanced#tcpip-interface)).
 
 
 
@@ -286,4 +286,3 @@ In the above simulations, the average solution time is **134us** and the maximum
 We ran a second set of simulations with double the original prediction horizon,
 namely $N=240$, and the average solution time increased to **343us** and the maximum time was
 **1.44ms**.
-

docs/python-interface.md

@@ -1,7 +1,7 @@
 ---
 id: python-interface
 title: Opengen basics
-description: Introduction to opengen: OpEn's Python interface
+description: "Introduction to opengen: OpEn's Python interface"
 ---
 
 <script type="text/x-mathjax-config">MathJax.Hub.Config({tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}});</script>
@@ -193,7 +193,7 @@ plan to use the optimizer on an embedded device.
 to <code>.with_tcp_interface_config()</code> a <code>TcpServerConfiguration</code> object.
 By default, the server will bind on <code>127.0.0.1</code> and will listen for
 requests at port <code>8333</code>.
-See the <a href="/optimization-engine/docs/python-advanced#tcp-ip-options">advanced options</a> for details.</div>
+See the <a href="/optimization-engine/docs/python-advanced#tcpip-interface">advanced options</a> for details.</div>
 
 
 This will instruct opegen to store the generated optimizer in

docs/python-tcp-ip.md

@@ -10,7 +10,7 @@ description: How to use the TCP/IP API for OpEn
 As discussed [previously], one possible way of invoking an auto-generated parametric
 optimizer is over a TCP/IP socket. 
 
-[previously]: /optimization-engine/docs/python-interface#calling-the-optimizer
+[previously]: /optimization-engine/docs/python-interface#calling-the-optimizer-locally
 
 <img src="/optimization-engine/img/edge_intelligence.png" alt="Edge Intelligence Logo"/>
 
@@ -33,7 +33,7 @@ $ RUST_LOG=tcp_iface=info cargo run
 We can then call the server from any programming language. Next, we will give examples
 using a Linux terminal and the command `netcat` (or `nc`).
 
-[`OptimizerTcpManager`]: /optimization-engine/docs/python-interface#calling-the-optimizer
+[`OptimizerTcpManager`]: /optimization-engine/docs/python-interface#calling-the-optimizer-locally
 
 
 ## TCP/IP Socket interface
@@ -152,4 +152,3 @@ The following errors may be returned to the client
 | 1700      | Wrong dimension of Langrange multipliers    |
 | 2000      | Problem solution failed (solver error)      |
 | 3003      | Vector `parameter` has wrong length         |
-

website/README.md

@@ -1,193 +1,57 @@
-This website was created with [Docusaurus](https://docusaurus.io/).
+This website now uses Docusaurus v3.
 
-# What's In This Document
+# Development
 
-* [Get Started in 5 Minutes](#get-started-in-5-minutes)
-* [Directory Structure](#directory-structure)
-* [Editing Content](#editing-content)
-* [Adding Content](#adding-content)
-* [Full Documentation](#full-documentation)
-
-# Get Started in 5 Minutes
-
-1. Make sure all the dependencies for the website are installed:
+Install dependencies:
 
 ```sh
-# Install dependencies
-$ yarn
-```
-2. Run your dev server:
-
-```sh
-# Start the site
-$ yarn start
-```
-
-## Directory Structure
-
-Your project file structure should look something like this
-
-```
-my-docusaurus/
-  docs/
-    doc-1.md
-    doc-2.md
-    doc-3.md
-  website/
-    blog/
-      2016-3-11-oldest-post.md
-      2017-10-24-newest-post.md
-    core/
-    node_modules/
-    pages/
-    static/
-      css/
-      img/
-    package.json
-    sidebar.json
-    siteConfig.js
-```
-
-# Editing Content
-
-## Editing an existing docs page
-
-Edit docs by navigating to `docs/` and editing the corresponding document:
-
-`docs/doc-to-be-edited.md`
-
-```markdown
----
-id: page-needs-edit
-title: This Doc Needs To Be Edited
----
-
-Edit me...
-```
-
-For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Editing an existing blog post
-
-Edit blog posts by navigating to `website/blog` and editing the corresponding post:
-
-`website/blog/post-to-be-edited.md`
-```markdown
----
-id: post-needs-edit
-title: This Blog Post Needs To Be Edited
----
-
-Edit me...
+yarn
 ```
 
-For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
-
-# Adding Content
-
-## Adding a new docs page to an existing sidebar
+Start the local dev server:
 
-1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
-
-```md
----
-id: newly-created-doc
-title: This Doc Needs To Be Edited
----
-
-My new content here..
+```sh
+yarn start
 ```
 
-1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:
+Build the production site:
 
-```javascript
-// Add newly-created-doc to the Getting Started category of docs
-{
-  "docs": {
-    "Getting Started": [
-      "quick-start",
-      "newly-created-doc" // new doc here
-    ],
-    ...
-  },
-  ...
-}
+```sh
+yarn build
 ```
 
-For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Adding a new blog post
-
-1. Make sure there is a header link to your blog in `website/siteConfig.js`:
+Preview the production build locally:
 
-`website/siteConfig.js`
-```javascript
-headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
+```sh
+yarn serve
 ```
 
-2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
-
-`website/blog/2018-05-21-New-Blog-Post.md`
-
-```markdown
----
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: New Blog Post
----
+Deploy to GitHub Pages:
 
-Lorem Ipsum...
+```sh
+yarn deploy
 ```
 
-For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
-
-## Adding items to your site's top navigation bar
+# Project Layout
 
-1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
-
-`website/siteConfig.js`
-```javascript
-{
-  headerLinks: [
-    ...
-    /* you can add docs */
-    { doc: 'my-examples', label: 'Examples' },
-    /* you can add custom pages */
-    { page: 'help', label: 'Help' },
-    /* you can add external links */
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
 ```
-
-For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Adding custom pages
-
-1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
-1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
-
-`website/siteConfig.js`
-```javascript
-{
-  headerLinks: [
-    ...
-    { page: 'my-new-custom-page', label: 'My New Custom Page' },
-    ...
-  ],
-  ...
-}
+optimization-engine/
+  docs/                  # documentation markdown files
+  website/
+    blog/                # blog posts
+    src/
+      css/
+      pages/
+    static/
+      img/
+      js/
+    docusaurus.config.js
+    sidebars.js
+    package.json
 ```
 
-For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
-
-# Full Documentation
+# Notes
 
-Full documentation can be found on the [website](https://docusaurus.io/).
+- The docs remain in the repository root under `/docs`.
+- Legacy inline MathJax and widget scripts are stripped at build time, and equivalent site-wide support is loaded from `website/static/js`.
+- Sidebar ordering now lives in `website/sidebars.js`.

website/blog/2019-03-02-superscs.md

@@ -1,5 +1,5 @@
 ---
-title: SuperSCS: OpEn's sister project
+title: "SuperSCS: OpEn's sister project"
 author: Pantelis Sopasakis
 authorURL: http://twitter.com/isToxic
 authorImageURL: https://pbs.twimg.com/profile_images/1062281000171003904/KkolV9Eg_400x400.jpg
@@ -9,4 +9,4 @@ authorImageURL: https://pbs.twimg.com/profile_images/1062281000171003904/KkolV9E
 
 SuperSCS is a fast solver for large-scale conic problems. It is written in C and can be interfaced from a lot of different programming languages.
 
-The paper titled "SuperSCS: fast and accurate large-scale conic optimization" (authors: P. Sopasakis, K. Menounou, P. Patrinos) has been accepted at European Control Conference 2019.
+The paper titled "SuperSCS: fast and accurate large-scale conic optimization" (authors: P. Sopasakis, K. Menounou, P. Patrinos) has been accepted at European Control Conference 2019.

website/blog/2019-03-15-pure-rust-optimization.md

@@ -1,5 +1,5 @@
 ---
-title: OpEn: a pure Rust optimizer
+title: "OpEn: a pure Rust optimizer"
 author: Pantelis Sopasakis
 authorURL: http://twitter.com/isToxic
 authorImageURL: https://pbs.twimg.com/profile_images/1062281000171003904/KkolV9Eg_400x400.jpg
@@ -9,4 +9,4 @@ The majority of optimization packages in Rust, such as [IPOPT](https://crates.io
 
 ![Rust language](/optimization-engine/img/rust1.jpeg)
 
-**OpEn** is the first **pure-Rust** package 
+**OpEn** is the first **pure-Rust** package