🎨 Re-brand to https://mystmd.org (#427)

jupyter-book · Jun 15, 2023 · 0410d19 · 0410d19
1 parent a2b9206
commit 0410d19
Show file tree

Hide file tree

Showing 26 changed files with 50 additions and 66 deletions.
diff --git a/.changeset/wild-ligers-hammer.md b/.changeset/wild-ligers-hammer.md
@@ -0,0 +1,7 @@
+---
+'myst-templates': patch
+'myst-cli': patch
+'jtex': patch
+---
+
+Move from myst-tools.org --> mystmd.org
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ The `mystjs` project provides a parser in Javascript (`mystjs`) and command line
   - PDFs and LaTeX documents, with specific templates for over 400 journals
   - Microsoft Word export
 
-See the [documentation](https://myst-tools.org/docs/mystjs).
+See the [documentation](https://mystmd.org/guide).
 
 ## Get Started
 
@@ -44,8 +44,8 @@ All packages for `mystjs` are included in this repository (a monorepo!).
 **Core Packages:**
 
 - `myst-cli` this will provide CLI functionality for `myst build mystdoc.md`
-- `jtex` a templating library ([see docs](https://myst-tools.org/docs/jtex))
-- `myst-frontmater` definitions and validation for scientific authorship/affiliation frontmatter ([see docs](https://myst-tools.org/docs/mystjs/frontmatter))
+- `jtex` a templating library ([see docs](https://mystmd.org/jtex))
+- `myst-frontmater` definitions and validation for scientific authorship/affiliation frontmatter ([see docs](https://mystmd.org/guide/frontmatter))
 - `myst-config` Validation and reading of configuration files
 - `myst-templates` types and validation for templates (LaTeX, web and word)
 

diff --git a/docs/analytics.md b/docs/analytics.md
@@ -31,7 +31,7 @@ Use the `site.analytics_plausible` configuration, with the contents being the **
 ```yaml
 version: 1
 site:
-  analytics_plausible: myst-tools.org # Domain(s) to track
+  analytics_plausible: mystmd.org # Domain(s) to track
 ```
 
 See [Plausible docs](https://plausible.io/docs/plausible-script) for more information on how to find the domain. Note, you only copy in the contents of: `data-domain="COPY_THIS"`, which can be a comma-separated list for multiple domains.

diff --git a/docs/cross-references.md b/docs/cross-references.md
@@ -20,7 +20,7 @@ See [](./citations.md) to cite scholarly work and create bibliographies.
 
 ## Directive Targets
 
-Targets are custom anchors that you can refer to elsewhere, for example, a figure, section, table, program, or proof. To be referenceable, they must have a `label`/`identifier` pair [in the AST](myst:spec#association). These can be created by setting the `label` option in many directives. For example, to label and reference a figure, use the following syntax:
+Targets are custom anchors that you can refer to elsewhere, for example, a figure, section, table, program, or proof. To be referenced, they must have a `label`/`identifier` pair [in the AST](myst:spec#association). These can be created by setting the `label` option in many directives. For example, to label and reference a figure, use the following syntax:
 
 % TODO: fix equation label redundancy here would nice to be able to simplify the onboarding (just use label, same as tex and ast)
 
@@ -178,7 +178,7 @@ See [](#my-math-label) for an equation!
 ## Notebook Cell Targets
 
 :::{warning}
-The following syntax for cross-referencing notebook cells is in `beta`, as it is not yet described by the [MyST Specification](https://myst-tools.org/docs/spec/). As such, it may change in the future.
+The following syntax for cross-referencing notebook cells is in `beta`, as it is not yet described by the [MyST Specification](myst:spec). As such, it may change in the future.
 :::
 
 You can label notebook cells using a comment at the top of the cell, using a `#| label:` syntax, or have this added directly in the notebook metadata for the cell.

diff --git a/docs/dropdowns-cards-and-tabs.md b/docs/dropdowns-cards-and-tabs.md
@@ -44,9 +44,9 @@ Card content
 You can also add a `link` argument to the card, which will allow you to make the entire card clickable.
 
 :::{card} Clickable Card
-:link: https://myst-tools.org
+:link: https://mystmd.org
 
-The entire card can be clicked to navigate to `myst-tools.org`.
+The entire card can be clicked to navigate to `mystmd.org`.
 :::
 
 ````{note} Compatibility with Sphinx design

diff --git a/docs/glossary.md b/docs/glossary.md
@@ -13,17 +13,17 @@ for {term}`MyST Markdown <MyST>` and {term}`Jupyter Book`.
 [ExecutableBookProject](https://executablebooks.org)
 : The project and [team](https://compass.executablebooks.org/en/latest/team/index.html) that supports {term}`Jupyter Book` and {term}`MyST Markdown <MyST>` and the tools and packages behind them.
 
-[MyST Markdown](https://myst-tools.org)
+[MyST Markdown](https://mystmd.org)
 : A flavour of Markdown that was designed for scientific and technical writing.
 : Sometimes referred to simply as {term}`MyST`.
 
-[MyST](https://myst-tools.org)
+[MyST](https://mystmd.org)
 : MyST can either refer to the _markup syntax_ or the _command-line interface_.
 : **Markup Syntax**: MyST is a flavour of Markdown that was designed for scientific and technical writing.
 MyST is a combination of {term}`CommonMark Markdown <CommonMark>` and extra syntax to support technical writing, such as cross-references, citations, equations and figures. For clarity in this usage, use {term}`MyST Markdown`.
 : **Command-Line Interface**: MyST is a parser and set of command-line tools for creating websites and documents. For clarity in this usage, use {term}`MyST-CLI`.
 
-[MyST-CLI](https://myst-tools.org/docs/mystjs)
+[MyST-CLI](https://mystmd.org/guide)
 : The MyST CLI can be used to create a website, PDF documents, and generally structure and parse a MyST project.
 : Sometimes referred to simply as {term}`MyST`.
 

diff --git a/docs/images/myst-build.png b/docs/images/myst-build.png
diff --git a/docs/index.md b/docs/index.md
@@ -119,7 +119,7 @@ Read about performance »
 **Technical Goals**
 
 - `mystjs` is a Javascript parser and command line tool for working with MyST Markdown
-- Parse MyST into a standardized [AST](wiki:Abstract_Syntax_Tree), that follows [the MyST Spec](https://myst-tools.org/docs/spec)
+- Parse MyST into a standardized [AST](wiki:Abstract_Syntax_Tree), that follows [the MyST Spec](https://mystmd.org/spec)
 - Translate and render MyST into:
   - Modern [interactive websites](./quickstart-myst-websites.md), using React (like this website!)
   - PDFs and $\LaTeX$ documents, with [specific templates for over 400 journals](./creating-pdf-documents.md)
@@ -152,5 +152,5 @@ For integration with **Sphinx**, use the Python implementation for MyST or Jupyt
 - [MyST Python Parser for Sphinx](https://myst-parser.readthedocs.io/en/latest/)
 - [JupyterBook](https://jupyterbook.org/)
 
-Although many tools in the [MyST Ecosystem](https://myst-tools.org) follow the same conventions and [specification](https://myst-tools.org/docs/spec), the following documentation refers only to the **Javascript** MyST CLI.
+Although many tools in the [MyST Ecosystem](https://mystmd.org) follow the same conventions and [specification](https://mystmd.org/spec), the following documentation refers only to the **Javascript** MyST CLI.
 ```
diff --git a/docs/myst.yml b/docs/myst.yml
@@ -9,6 +9,8 @@ project:
   references:
     python: https://docs.python.org/3.7/
     jupyterbook: https://jupyterbook.org/en/stable/
+    jtex: https://mystmd.org/jtex/
+    spec: https://mystmd.org/spec/
   abbreviations:
     AST: Abstract Syntax Tree
     DOI: Digital Object Identifier
@@ -40,8 +42,5 @@ project:
     OA: Open Access
 site:
   title: MyST Markdown Guide
-  projects:
-    - path: .
-      slug: mystjs
   domains:
-    - mystjs.myst.tools
+    - mystmd-guide.curve.space
diff --git a/docs/quickstart-myst-documents.md b/docs/quickstart-myst-documents.md
@@ -318,7 +318,7 @@ The export process will run for any known files with `docx` specified in the `ex
 📬 Performing exports:
    01-paper.md -> _build/exports/paper.docx
 📖 Built 01-paper.md in 247 ms.
-🔍 Querying template metadata from https://api.myst-tools.org/templates/docx/myst/default
+🔍 Querying template metadata from https://api.mystmd.org/templates/docx/myst/default
 🐕 Fetching template from https://github.com/myst-templates/docx_default/archive/refs/heads/main.zip
 💾 Saved template to path _build/templates/docx/myst/default
 📄 Exported DOCX in 166 ms, copying to _build/exports/paper.docx

diff --git a/docs/quickstart-myst-websites.md b/docs/quickstart-myst-websites.md
@@ -71,7 +71,7 @@ You can use myst to:
  - create interactive websites from markdown and Jupyter Notebooks 📈
  - build & export professional PDFs and Word documents 📄
 
-Learn more about this CLI and MyST Markdown at: https://myst-tools.org
+Learn more about this CLI and MyST Markdown at: https://mystmd.org
 
 💾 Writing new project and site config file: myst.yml
 ```
@@ -87,7 +87,7 @@ Starting the server requires a theme, this will download the default `book-theme
 The theme will now install using `node` and `npm`, this can take **up to a minute** the first time, and then will be cached in the `_build/templates` directory.
 
 ```text
-🐕 Fetching template metadata from https://api.myst-tools.org/templates/site/myst/book-theme
+🐕 Fetching template metadata from https://api.mystmd.org/templates/site/myst/book-theme
 💾 Saved template to path _build/templates/site/myst/book-theme
 ⤵️ Installing web libraries (can take up to 60 s)
 📦 Installed web libraries in 13 s
@@ -175,7 +175,7 @@ The `_build` folder also contains your templates (including the site template yo
 If we open and look inside our `myst.yml` we will see a basic configuration like this:
 
 ```yaml
-# See docs at: https://myst-tools.org/docs/mystjs/frontmatter
+# See docs at: https://mystmd.org/guide/frontmatter
 version: 1
 project:
   # title:
@@ -191,7 +191,7 @@ site:
   nav: []
   actions:
     - title: Learn More
-      url: https://myst-tools.org/docs/mystjs
+      url: https://mystmd.org/guide
   domains: []
 ```
 

diff --git a/packages/jtex/docs/contribute-a-template.md b/packages/jtex/docs/contribute-a-template.md
@@ -11,7 +11,7 @@ To see all of the community templates use:
 myst templates list --tex
 ```
 
-These will show you the list of community templates available, which are also possible to access through the MyST API, at https://api.myst-tools.org.
+These will show you the list of community templates available, which are also possible to access through the MyST API, at https://api.mystmd.org.
 
 ## List your Template
 

diff --git a/packages/jtex/docs/create-a-latex-template.md b/packages/jtex/docs/create-a-latex-template.md
@@ -326,4 +326,4 @@ You can choose to also list your template so that it is available to any one els
 See [](./contribute-a-template.md) for more information!
 ```
 
-Nice work on creating a template, share the word on [twitter](https://twitter.com/intent/tweet?text=I%20just%20created%20a%20new%20MyST%20Markdown%20template!&url=https://myst-tools.org/docs/jtex/create-a-latex-template&via=executablebooks), and think about [contributing your template](./contribute-a-template.md) to make it discoverable to other users!
+Nice work on creating a template, share the word on [twitter](https://twitter.com/intent/tweet?text=I%20just%20created%20a%20new%20MyST%20Markdown%20template!&url=https://mystmd.org/jtex/create-a-latex-template&via=executablebooks), and think about [contributing your template](./contribute-a-template.md) to make it discoverable to other users!
diff --git a/packages/jtex/docs/index.md b/packages/jtex/docs/index.md
@@ -36,7 +36,7 @@ Use `jtex` to list templates, quickly render content, or fix your `template.yml`
 :class: dropdown
 # Looking for Templates?
 
-MyST Templates are available in the [myst-templates organization](https://github.com/myst-templates) on GitHub. You can also see all listed community templates using `myst templates list`, or browse the [api](https://api.myst-tools.org/templates/tex) if you are into JSON.
+MyST Templates are available in the [myst-templates organization](https://github.com/myst-templates) on GitHub. You can also see all listed community templates using `myst templates list`, or browse the [api](https://api.mystmd.org/templates/tex) if you are into JSON.
 
 To create your own template see [](./create-a-latex-template.md).
 ```

diff --git a/packages/jtex/docs/myst.yml b/packages/jtex/docs/myst.yml
@@ -6,8 +6,5 @@ project:
   subject: Jinja LaTeX Templates
 site:
   title: JTeX
-  projects:
-    - path: .
-      slug: jtex
   domains:
-    - jtex.myst.tools
+    - mystmd-jtex.curve.space
diff --git a/packages/myst-cli/README.md b/packages/myst-cli/README.md
@@ -1,3 +1,3 @@
 # myst-cli
 
-See the [docs](https://myst-tools.org/docs/mystjs).
+See the [docs](https://mystmd.org/cli).
diff --git a/packages/myst-cli/docs/myst.yml b/packages/myst-cli/docs/myst.yml
@@ -1,13 +1,10 @@
 version: 1
 project:
-  title: MyST CLI
+  title: MyST Markdown CLI
   github: https://github.com/executablebooks/mystjs/tree/main/packages/myst-cli
   license: MIT
   subject: MyST CLI
 site:
   title: MyST CLI
-  projects:
-    - path: .
-      slug: myst-cli
   domains:
-    - myst-cli.myst.tools
+    - mystmd-cli.curve.space
diff --git a/packages/myst-cli/src/build/init.ts b/packages/myst-cli/src/build/init.ts
@@ -10,8 +10,7 @@ import chalk from 'chalk';
 import { startServer } from './site/start.js';
 import { makeExecutable } from 'myst-cli-utils';
 
-const VERSION_CONFIG =
-  '# See docs at: https://myst-tools.org/docs/mystjs/frontmatter\nversion: 1\n';
+const VERSION_CONFIG = '# See docs at: https://mystmd.org/guide/frontmatter\nversion: 1\n';
 
 function createProjectConfig({ github }: { github?: string } = {}) {
   return `project:
@@ -27,13 +26,10 @@ const SITE_CONFIG = `site:
   template: book-theme
   # title:
   # logo:
-  projects:
-    - slug: myst
-      path: .
   nav: []
   actions:
     - title: Learn More
-      url: https://myst-tools.org/docs/mystjs
+      url: https://mystmd.org/guide
   domains: []
 `;
 
@@ -53,7 +49,7 @@ You can use myst to:
  - create interactive ${chalk.bold.magenta('websites')} from markdown and Jupyter Notebooks 📈
  - ${chalk.bold.magenta('build & export')} professional PDFs and Word documents 📄
 
-Learn more about this CLI and MyST Markdown at: ${chalk.bold('https://myst-tools.org')}
+Learn more about this CLI and MyST Markdown at: ${chalk.bold('https://mystmd.org')}
 
 `;
 

diff --git a/packages/myst-cli/src/session/session.ts b/packages/myst-cli/src/session/session.ts
@@ -13,7 +13,7 @@ import {
 } from '../config.js';
 
 const CONFIG_FILES = ['myst.yml'];
-const API_URL = 'https://api.myst-tools.org';
+const API_URL = 'https://api.mystmd.org';
 
 export class Session implements ISession {
   API_URL: string;

diff --git a/packages/myst-cli/tests/basic-md-and-config/myst.yml b/packages/myst-cli/tests/basic-md-and-config/myst.yml
@@ -1,4 +1,4 @@
-# See docs at: https://myst-tools.org/docs/mystjs/frontmatter
+# See docs at: https://mystmd.org/guide/frontmatter
 version: 1
 project:
   # title:
@@ -11,11 +11,8 @@ site:
   template: book-theme
   # title:
   # logo:
-  projects:
-    - slug: myst
-      path: .
   nav: []
   actions:
     - title: Learn More
-      url: https://myst-tools.org/docs/mystjs
+      url: https://mystmd.org/guide
   domains: []
diff --git a/packages/myst-templates/src/download.spec.ts b/packages/myst-templates/src/download.spec.ts
@@ -11,7 +11,7 @@ describe('resolveInputs', () => {
   it('default path and url fill correctly', async () => {
     expect(resolveInputs(new Session(), { kind: TemplateKind.tex })).toEqual({
       templatePath: 'templates/tex/myst/curvenote',
-      templateUrl: 'https://api.myst-tools.org/templates/tex/myst/curvenote',
+      templateUrl: 'https://api.mystmd.org/templates/tex/myst/curvenote',
     });
   });
   it('template as path to template file exists', async () => {
@@ -46,13 +46,13 @@ describe('resolveInputs', () => {
       }),
     ).toEqual({
       templatePath: '_build/templates/tex/private/journal',
-      templateUrl: 'https://api.myst-tools.org/templates/tex/private/journal',
+      templateUrl: 'https://api.mystmd.org/templates/tex/private/journal',
     });
   });
   it('template name is prefixed with public', async () => {
     expect(resolveInputs(new Session(), { kind: TemplateKind.tex, template: 'journal' })).toEqual({
       templatePath: 'templates/tex/myst/journal',
-      templateUrl: 'https://api.myst-tools.org/templates/tex/myst/journal',
+      templateUrl: 'https://api.mystmd.org/templates/tex/myst/journal',
     });
   });
   it('invalid template errors', async () => {

diff --git a/packages/myst-templates/src/session.ts b/packages/myst-templates/src/session.ts
@@ -3,7 +3,7 @@ import type { Logger } from 'myst-cli-utils';
 import type { ISession } from './types.js';
 
 export class Session implements ISession {
-  API_URL = 'https://api.myst-tools.org';
+  API_URL = 'https://api.mystmd.org';
   log: Logger;
   constructor(opts?: { logger?: Logger }) {
     this.log = opts?.logger ?? chalkLogger(LogLevel.debug);

diff --git a/packages/myst-to-jats/docs/myst.yml b/packages/myst-to-jats/docs/myst.yml
@@ -6,8 +6,5 @@ project:
   subject: MyST Converters
 site:
   title: MyST to JATS
-  projects:
-    - path: .
-      slug: myst-to-jats
   domains:
-    - myst-to-jats.myst.tools
+    - mystmd-myst_to_jats.curve.space
diff --git a/packages/myst-to-jats/tests/basic.yml b/packages/myst-to-jats/tests/basic.yml
@@ -91,11 +91,11 @@ cases:
         - type: paragraph
           children:
             - type: link
-              url: https://myst-tools.org
+              url: https://mystmd.org
               children:
                 - type: text
                   value: MyST
-    jats: <p><ext-link ext-link-type="uri" xlink:href="https://myst-tools.org">MyST</ext-link></p>
+    jats: <p><ext-link ext-link-type="uri" xlink:href="https://mystmd.org">MyST</ext-link></p>
   - title: Smallcaps
     tree:
       type: root

diff --git a/packages/myst-to-md/docs/myst.yml b/packages/myst-to-md/docs/myst.yml
@@ -6,8 +6,5 @@ project:
   subject: MyST Converters
 site:
   title: MyST to Markdown
-  projects:
-    - path: .
-      slug: myst-to-md
   domains:
-    - myst-to-md.myst.tools
+    - mystmd-myst_to_md.curve.space
diff --git a/packages/myst-transforms/docs/myst.yml b/packages/myst-transforms/docs/myst.yml
@@ -6,8 +6,5 @@ project:
   subject: MyST Transforms
 site:
   title: MyST Transforms
-  projects:
-    - path: .
-      slug: myst-transforms
   domains:
-    - myst-transforms.myst.tools
+    - mystmd-myst_transforms.curve.space