diff --git a/website/docs/api/architectures.md b/website/docs/api/architectures.mdx similarity index 100% rename from website/docs/api/architectures.md rename to website/docs/api/architectures.mdx diff --git a/website/docs/api/attributeruler.md b/website/docs/api/attributeruler.mdx similarity index 100% rename from website/docs/api/attributeruler.md rename to website/docs/api/attributeruler.mdx diff --git a/website/docs/api/attributes.md b/website/docs/api/attributes.mdx similarity index 100% rename from website/docs/api/attributes.md rename to website/docs/api/attributes.mdx diff --git a/website/docs/api/cli.md b/website/docs/api/cli.mdx similarity index 100% rename from website/docs/api/cli.md rename to website/docs/api/cli.mdx diff --git a/website/docs/api/coref.md b/website/docs/api/coref.mdx similarity index 100% rename from website/docs/api/coref.md rename to website/docs/api/coref.mdx diff --git a/website/docs/api/corpus.md b/website/docs/api/corpus.mdx similarity index 100% rename from website/docs/api/corpus.md rename to website/docs/api/corpus.mdx diff --git a/website/docs/api/cython-classes.md b/website/docs/api/cython-classes.mdx similarity index 100% rename from website/docs/api/cython-classes.md rename to website/docs/api/cython-classes.mdx diff --git a/website/docs/api/cython-structs.md b/website/docs/api/cython-structs.mdx similarity index 100% rename from website/docs/api/cython-structs.md rename to website/docs/api/cython-structs.mdx diff --git a/website/docs/api/cython.md b/website/docs/api/cython.mdx similarity index 100% rename from website/docs/api/cython.md rename to website/docs/api/cython.mdx diff --git a/website/docs/api/data-formats.md b/website/docs/api/data-formats.mdx similarity index 100% rename from website/docs/api/data-formats.md rename to website/docs/api/data-formats.mdx diff --git a/website/docs/api/dependencymatcher.md b/website/docs/api/dependencymatcher.mdx similarity index 100% rename from website/docs/api/dependencymatcher.md rename to website/docs/api/dependencymatcher.mdx diff --git a/website/docs/api/dependencyparser.md b/website/docs/api/dependencyparser.mdx similarity index 100% rename from website/docs/api/dependencyparser.md rename to website/docs/api/dependencyparser.mdx diff --git a/website/docs/api/doc.md b/website/docs/api/doc.mdx similarity index 100% rename from website/docs/api/doc.md rename to website/docs/api/doc.mdx diff --git a/website/docs/api/docbin.md b/website/docs/api/docbin.mdx similarity index 100% rename from website/docs/api/docbin.md rename to website/docs/api/docbin.mdx diff --git a/website/docs/api/edittreelemmatizer.md b/website/docs/api/edittreelemmatizer.mdx similarity index 100% rename from website/docs/api/edittreelemmatizer.md rename to website/docs/api/edittreelemmatizer.mdx diff --git a/website/docs/api/entitylinker.md b/website/docs/api/entitylinker.mdx similarity index 100% rename from website/docs/api/entitylinker.md rename to website/docs/api/entitylinker.mdx diff --git a/website/docs/api/entityrecognizer.md b/website/docs/api/entityrecognizer.mdx similarity index 100% rename from website/docs/api/entityrecognizer.md rename to website/docs/api/entityrecognizer.mdx diff --git a/website/docs/api/entityruler.md b/website/docs/api/entityruler.mdx similarity index 100% rename from website/docs/api/entityruler.md rename to website/docs/api/entityruler.mdx diff --git a/website/docs/api/example.md b/website/docs/api/example.mdx similarity index 100% rename from website/docs/api/example.md rename to website/docs/api/example.mdx diff --git a/website/docs/api/index.md b/website/docs/api/index.mdx similarity index 58% rename from website/docs/api/index.md rename to website/docs/api/index.mdx index a9dc408f6..ba1e0a29a 100644 --- a/website/docs/api/index.md +++ b/website/docs/api/index.mdx @@ -3,6 +3,6 @@ title: Library Architecture next: /api/architectures --- -import Architecture101 from 'usage/101/\_architecture.md' +import Architecture101 from 'usage/101/\_architecture.mdx' diff --git a/website/docs/api/kb.md b/website/docs/api/kb.mdx similarity index 100% rename from website/docs/api/kb.md rename to website/docs/api/kb.mdx diff --git a/website/docs/api/kb_in_memory.md b/website/docs/api/kb_in_memory.mdx similarity index 100% rename from website/docs/api/kb_in_memory.md rename to website/docs/api/kb_in_memory.mdx diff --git a/website/docs/api/language.md b/website/docs/api/language.mdx similarity index 100% rename from website/docs/api/language.md rename to website/docs/api/language.mdx diff --git a/website/docs/api/legacy.md b/website/docs/api/legacy.mdx similarity index 100% rename from website/docs/api/legacy.md rename to website/docs/api/legacy.mdx diff --git a/website/docs/api/lemmatizer.md b/website/docs/api/lemmatizer.mdx similarity index 100% rename from website/docs/api/lemmatizer.md rename to website/docs/api/lemmatizer.mdx diff --git a/website/docs/api/lexeme.md b/website/docs/api/lexeme.mdx similarity index 100% rename from website/docs/api/lexeme.md rename to website/docs/api/lexeme.mdx diff --git a/website/docs/api/lookups.md b/website/docs/api/lookups.mdx similarity index 100% rename from website/docs/api/lookups.md rename to website/docs/api/lookups.mdx diff --git a/website/docs/api/matcher.md b/website/docs/api/matcher.mdx similarity index 100% rename from website/docs/api/matcher.md rename to website/docs/api/matcher.mdx diff --git a/website/docs/api/morphologizer.md b/website/docs/api/morphologizer.mdx similarity index 100% rename from website/docs/api/morphologizer.md rename to website/docs/api/morphologizer.mdx diff --git a/website/docs/api/morphology.md b/website/docs/api/morphology.mdx similarity index 100% rename from website/docs/api/morphology.md rename to website/docs/api/morphology.mdx diff --git a/website/docs/api/phrasematcher.md b/website/docs/api/phrasematcher.mdx similarity index 100% rename from website/docs/api/phrasematcher.md rename to website/docs/api/phrasematcher.mdx diff --git a/website/docs/api/pipe.md b/website/docs/api/pipe.mdx similarity index 100% rename from website/docs/api/pipe.md rename to website/docs/api/pipe.mdx diff --git a/website/docs/api/pipeline-functions.md b/website/docs/api/pipeline-functions.mdx similarity index 100% rename from website/docs/api/pipeline-functions.md rename to website/docs/api/pipeline-functions.mdx diff --git a/website/docs/api/scorer.md b/website/docs/api/scorer.mdx similarity index 100% rename from website/docs/api/scorer.md rename to website/docs/api/scorer.mdx diff --git a/website/docs/api/sentencerecognizer.md b/website/docs/api/sentencerecognizer.mdx similarity index 100% rename from website/docs/api/sentencerecognizer.md rename to website/docs/api/sentencerecognizer.mdx diff --git a/website/docs/api/sentencizer.md b/website/docs/api/sentencizer.mdx similarity index 100% rename from website/docs/api/sentencizer.md rename to website/docs/api/sentencizer.mdx diff --git a/website/docs/api/span-resolver.md b/website/docs/api/span-resolver.mdx similarity index 100% rename from website/docs/api/span-resolver.md rename to website/docs/api/span-resolver.mdx diff --git a/website/docs/api/span.md b/website/docs/api/span.mdx similarity index 100% rename from website/docs/api/span.md rename to website/docs/api/span.mdx diff --git a/website/docs/api/spancategorizer.md b/website/docs/api/spancategorizer.mdx similarity index 100% rename from website/docs/api/spancategorizer.md rename to website/docs/api/spancategorizer.mdx diff --git a/website/docs/api/spangroup.md b/website/docs/api/spangroup.mdx similarity index 100% rename from website/docs/api/spangroup.md rename to website/docs/api/spangroup.mdx diff --git a/website/docs/api/spanruler.md b/website/docs/api/spanruler.mdx similarity index 100% rename from website/docs/api/spanruler.md rename to website/docs/api/spanruler.mdx diff --git a/website/docs/api/stringstore.md b/website/docs/api/stringstore.mdx similarity index 100% rename from website/docs/api/stringstore.md rename to website/docs/api/stringstore.mdx diff --git a/website/docs/api/tagger.md b/website/docs/api/tagger.mdx similarity index 100% rename from website/docs/api/tagger.md rename to website/docs/api/tagger.mdx diff --git a/website/docs/api/textcategorizer.md b/website/docs/api/textcategorizer.mdx similarity index 100% rename from website/docs/api/textcategorizer.md rename to website/docs/api/textcategorizer.mdx diff --git a/website/docs/api/tok2vec.md b/website/docs/api/tok2vec.mdx similarity index 100% rename from website/docs/api/tok2vec.md rename to website/docs/api/tok2vec.mdx diff --git a/website/docs/api/token.md b/website/docs/api/token.mdx similarity index 100% rename from website/docs/api/token.md rename to website/docs/api/token.mdx diff --git a/website/docs/api/tokenizer.md b/website/docs/api/tokenizer.mdx similarity index 100% rename from website/docs/api/tokenizer.md rename to website/docs/api/tokenizer.mdx diff --git a/website/docs/api/top-level.md b/website/docs/api/top-level.mdx similarity index 100% rename from website/docs/api/top-level.md rename to website/docs/api/top-level.mdx diff --git a/website/docs/api/transformer.md b/website/docs/api/transformer.mdx similarity index 100% rename from website/docs/api/transformer.md rename to website/docs/api/transformer.mdx diff --git a/website/docs/api/vectors.md b/website/docs/api/vectors.mdx similarity index 100% rename from website/docs/api/vectors.md rename to website/docs/api/vectors.mdx diff --git a/website/docs/api/vocab.md b/website/docs/api/vocab.mdx similarity index 100% rename from website/docs/api/vocab.md rename to website/docs/api/vocab.mdx diff --git a/website/docs/index.md b/website/docs/index.mdx similarity index 100% rename from website/docs/index.md rename to website/docs/index.mdx diff --git a/website/docs/models/index.md b/website/docs/models/index.mdx similarity index 100% rename from website/docs/models/index.md rename to website/docs/models/index.mdx diff --git a/website/docs/styleguide.md b/website/docs/styleguide.mdx similarity index 99% rename from website/docs/styleguide.md rename to website/docs/styleguide.mdx index 47bca1ed4..f97ad7d3d 100644 --- a/website/docs/styleguide.md +++ b/website/docs/styleguide.mdx @@ -539,7 +539,7 @@ sit amet dignissim justo congue. ## Markdown reference {#markdown} -All page content and page meta lives in the `.md` files in the `/docs` +All page content and page meta lives in the `.mdx` files in the `/docs` directory. The frontmatter block at the top of each file defines the page title and other settings like the sidebar menu. diff --git a/website/docs/usage/101/_architecture.md b/website/docs/usage/101/_architecture.mdx similarity index 100% rename from website/docs/usage/101/_architecture.md rename to website/docs/usage/101/_architecture.mdx diff --git a/website/docs/usage/101/_language-data.md b/website/docs/usage/101/_language-data.mdx similarity index 100% rename from website/docs/usage/101/_language-data.md rename to website/docs/usage/101/_language-data.mdx diff --git a/website/docs/usage/101/_named-entities.md b/website/docs/usage/101/_named-entities.mdx similarity index 100% rename from website/docs/usage/101/_named-entities.md rename to website/docs/usage/101/_named-entities.mdx diff --git a/website/docs/usage/101/_pipelines.md b/website/docs/usage/101/_pipelines.mdx similarity index 100% rename from website/docs/usage/101/_pipelines.md rename to website/docs/usage/101/_pipelines.mdx diff --git a/website/docs/usage/101/_pos-deps.md b/website/docs/usage/101/_pos-deps.mdx similarity index 100% rename from website/docs/usage/101/_pos-deps.md rename to website/docs/usage/101/_pos-deps.mdx diff --git a/website/docs/usage/101/_serialization.md b/website/docs/usage/101/_serialization.mdx similarity index 100% rename from website/docs/usage/101/_serialization.md rename to website/docs/usage/101/_serialization.mdx diff --git a/website/docs/usage/101/_tokenization.md b/website/docs/usage/101/_tokenization.mdx similarity index 100% rename from website/docs/usage/101/_tokenization.md rename to website/docs/usage/101/_tokenization.mdx diff --git a/website/docs/usage/101/_training.md b/website/docs/usage/101/_training.mdx similarity index 100% rename from website/docs/usage/101/_training.md rename to website/docs/usage/101/_training.mdx diff --git a/website/docs/usage/101/_vectors-similarity.md b/website/docs/usage/101/_vectors-similarity.mdx similarity index 100% rename from website/docs/usage/101/_vectors-similarity.md rename to website/docs/usage/101/_vectors-similarity.mdx diff --git a/website/docs/usage/_benchmarks-models.md b/website/docs/usage/_benchmarks-models.mdx similarity index 100% rename from website/docs/usage/_benchmarks-models.md rename to website/docs/usage/_benchmarks-models.mdx diff --git a/website/docs/usage/embeddings-transformers.md b/website/docs/usage/embeddings-transformers.mdx similarity index 100% rename from website/docs/usage/embeddings-transformers.md rename to website/docs/usage/embeddings-transformers.mdx diff --git a/website/docs/usage/facts-figures.md b/website/docs/usage/facts-figures.mdx similarity index 99% rename from website/docs/usage/facts-figures.md rename to website/docs/usage/facts-figures.mdx index 4bee31ed0..4c9d7e644 100644 --- a/website/docs/usage/facts-figures.md +++ b/website/docs/usage/facts-figures.mdx @@ -69,7 +69,7 @@ pipeline, which is less accurate but much cheaper to run. > gold-standard segmentation and tokenization, from a pretty specific type of > text (articles from a single newspaper, 1984-1989). -import Benchmarks from 'usage/\_benchmarks-models.md' +import Benchmarks from 'usage/\_benchmarks-models.mdx' diff --git a/website/docs/usage/index.md b/website/docs/usage/index.mdx similarity index 100% rename from website/docs/usage/index.md rename to website/docs/usage/index.mdx diff --git a/website/docs/usage/layers-architectures.md b/website/docs/usage/layers-architectures.mdx similarity index 100% rename from website/docs/usage/layers-architectures.md rename to website/docs/usage/layers-architectures.mdx diff --git a/website/docs/usage/linguistic-features.md b/website/docs/usage/linguistic-features.mdx similarity index 99% rename from website/docs/usage/linguistic-features.md rename to website/docs/usage/linguistic-features.mdx index 099678c40..8fe8b2c1a 100644 --- a/website/docs/usage/linguistic-features.md +++ b/website/docs/usage/linguistic-features.mdx @@ -28,7 +28,7 @@ annotations. ## Part-of-speech tagging {#pos-tagging model="tagger, parser"} -import PosDeps101 from 'usage/101/\_pos-deps.md' +import PosDeps101 from 'usage/101/\_pos-deps.mdx' @@ -536,7 +536,7 @@ with new examples. ### Named Entity Recognition 101 {#named-entities-101} -import NER101 from 'usage/101/\_named-entities.md' +import NER101 from 'usage/101/\_named-entities.mdx' @@ -785,7 +785,7 @@ during tokenization. This is kind of a core principle of spaCy's `Doc` object: -import Tokenization101 from 'usage/101/\_tokenization.md' +import Tokenization101 from 'usage/101/\_tokenization.mdx' @@ -1868,7 +1868,7 @@ initialized before training. See the ## Word vectors and semantic similarity {#vectors-similarity} -import Vectors101 from 'usage/101/\_vectors-similarity.md' +import Vectors101 from 'usage/101/\_vectors-similarity.mdx' @@ -1998,7 +1998,7 @@ for word, vector in vector_data.items(): ## Language Data {#language-data} -import LanguageData101 from 'usage/101/\_language-data.md' +import LanguageData101 from 'usage/101/\_language-data.mdx' diff --git a/website/docs/usage/models.md b/website/docs/usage/models.mdx similarity index 100% rename from website/docs/usage/models.md rename to website/docs/usage/models.mdx diff --git a/website/docs/usage/processing-pipelines.md b/website/docs/usage/processing-pipelines.mdx similarity index 99% rename from website/docs/usage/processing-pipelines.md rename to website/docs/usage/processing-pipelines.mdx index 0b63cdcb8..c31ad0a99 100644 --- a/website/docs/usage/processing-pipelines.md +++ b/website/docs/usage/processing-pipelines.mdx @@ -12,7 +12,7 @@ menu: - ['Plugins & Wrappers', 'plugins'] --- -import Pipelines101 from 'usage/101/\_pipelines.md' +import Pipelines101 from 'usage/101/\_pipelines.mdx' diff --git a/website/docs/usage/projects.md b/website/docs/usage/projects.mdx similarity index 100% rename from website/docs/usage/projects.md rename to website/docs/usage/projects.mdx diff --git a/website/docs/usage/rule-based-matching.md b/website/docs/usage/rule-based-matching.mdx similarity index 100% rename from website/docs/usage/rule-based-matching.md rename to website/docs/usage/rule-based-matching.mdx diff --git a/website/docs/usage/saving-loading.md b/website/docs/usage/saving-loading.mdx similarity index 99% rename from website/docs/usage/saving-loading.md rename to website/docs/usage/saving-loading.mdx index 29870a2e3..0ee933177 100644 --- a/website/docs/usage/saving-loading.md +++ b/website/docs/usage/saving-loading.mdx @@ -10,7 +10,7 @@ menu: ## Basics {#basics hidden="true"} -import Serialization101 from 'usage/101/\_serialization.md' +import Serialization101 from 'usage/101/\_serialization.mdx' diff --git a/website/docs/usage/spacy-101.md b/website/docs/usage/spacy-101.mdx similarity index 98% rename from website/docs/usage/spacy-101.md rename to website/docs/usage/spacy-101.mdx index 52daf33b8..47d0954ae 100644 --- a/website/docs/usage/spacy-101.md +++ b/website/docs/usage/spacy-101.mdx @@ -191,7 +191,7 @@ text with spaCy. ### Tokenization {#annotations-token} -import Tokenization101 from 'usage/101/\_tokenization.md' +import Tokenization101 from 'usage/101/\_tokenization.mdx' @@ -207,7 +207,7 @@ language-specific data**, see the usage guides on ### Part-of-speech tags and dependencies {#annotations-pos-deps model="parser"} -import PosDeps101 from 'usage/101/\_pos-deps.md' +import PosDeps101 from 'usage/101/\_pos-deps.mdx' @@ -222,7 +222,7 @@ how to **navigate and use the parse tree** effectively, see the usage guides on ### Named Entities {#annotations-ner model="ner"} -import NER101 from 'usage/101/\_named-entities.md' +import NER101 from 'usage/101/\_named-entities.mdx' @@ -238,7 +238,7 @@ of a model, see the usage guides on ### Word vectors and similarity {#vectors-similarity model="vectors"} -import Vectors101 from 'usage/101/\_vectors-similarity.md' +import Vectors101 from 'usage/101/\_vectors-similarity.mdx' @@ -252,7 +252,7 @@ To learn more about word vectors, how to **customize them** and how to load ## Pipelines {#pipelines} -import Pipelines101 from 'usage/101/\_pipelines.md' +import Pipelines101 from 'usage/101/\_pipelines.mdx' @@ -266,7 +266,7 @@ guide on [language processing pipelines](/usage/processing-pipelines). ## Architecture {#architecture} -import Architecture101 from 'usage/101/\_architecture.md' +import Architecture101 from 'usage/101/\_architecture.mdx' @@ -384,7 +384,7 @@ it. ## Serialization {#serialization} -import Serialization101 from 'usage/101/\_serialization.md' +import Serialization101 from 'usage/101/\_serialization.mdx' @@ -397,7 +397,7 @@ guide on [saving and loading](/usage/saving-loading#models). ## Training {#training} -import Training101 from 'usage/101/\_training.md' +import Training101 from 'usage/101/\_training.mdx' @@ -476,7 +476,7 @@ for trainable components. ## Language data {#language-data} -import LanguageData101 from 'usage/101/\_language-data.md' +import LanguageData101 from 'usage/101/\_language-data.mdx' diff --git a/website/docs/usage/training.md b/website/docs/usage/training.mdx similarity index 99% rename from website/docs/usage/training.md rename to website/docs/usage/training.mdx index e40a395c4..0b471c359 100644 --- a/website/docs/usage/training.md +++ b/website/docs/usage/training.mdx @@ -17,7 +17,7 @@ menu: ## Introduction to training {#basics hidden="true"} -import Training101 from 'usage/101/\_training.md' +import Training101 from 'usage/101/\_training.mdx' diff --git a/website/docs/usage/v2-1.md b/website/docs/usage/v2-1.mdx similarity index 100% rename from website/docs/usage/v2-1.md rename to website/docs/usage/v2-1.mdx diff --git a/website/docs/usage/v2-2.md b/website/docs/usage/v2-2.mdx similarity index 100% rename from website/docs/usage/v2-2.md rename to website/docs/usage/v2-2.mdx diff --git a/website/docs/usage/v2-3.md b/website/docs/usage/v2-3.mdx similarity index 100% rename from website/docs/usage/v2-3.md rename to website/docs/usage/v2-3.mdx diff --git a/website/docs/usage/v2.md b/website/docs/usage/v2.mdx similarity index 100% rename from website/docs/usage/v2.md rename to website/docs/usage/v2.mdx diff --git a/website/docs/usage/v3-1.md b/website/docs/usage/v3-1.mdx similarity index 100% rename from website/docs/usage/v3-1.md rename to website/docs/usage/v3-1.mdx diff --git a/website/docs/usage/v3-2.md b/website/docs/usage/v3-2.mdx similarity index 100% rename from website/docs/usage/v3-2.md rename to website/docs/usage/v3-2.mdx diff --git a/website/docs/usage/v3-3.md b/website/docs/usage/v3-3.mdx similarity index 100% rename from website/docs/usage/v3-3.md rename to website/docs/usage/v3-3.mdx diff --git a/website/docs/usage/v3-4.md b/website/docs/usage/v3-4.mdx similarity index 100% rename from website/docs/usage/v3-4.md rename to website/docs/usage/v3-4.mdx diff --git a/website/docs/usage/v3.md b/website/docs/usage/v3.mdx similarity index 99% rename from website/docs/usage/v3.md rename to website/docs/usage/v3.mdx index 64f93b7c0..e8d62efe5 100644 --- a/website/docs/usage/v3.md +++ b/website/docs/usage/v3.mdx @@ -88,7 +88,7 @@ giving you access to thousands of pretrained models for your pipelines. ![Pipeline components listening to shared embedding component](../images/tok2vec-listener.svg) -import Benchmarks from 'usage/\_benchmarks-models.md' +import Benchmarks from 'usage/\_benchmarks-models.mdx' diff --git a/website/docs/usage/visualizers.md b/website/docs/usage/visualizers.mdx similarity index 100% rename from website/docs/usage/visualizers.md rename to website/docs/usage/visualizers.mdx diff --git a/website/src/components/util.js b/website/src/components/util.js index 7b73d484a..7a1412125 100644 --- a/website/src/components/util.js +++ b/website/src/components/util.js @@ -33,11 +33,11 @@ export function github(filepath, branch = DEFAULT_BRANCH) { /** * Get the source of a file in the documentation based on its slug * @param {string} slug - The slug, e.g. /api/doc. - * @param {boolean} [isIndex] - Whether the page is an index, e.g. /api/index.md + * @param {boolean} [isIndex] - Whether the page is an index, e.g. /api/index.mdx * @param {string} [branch] - Optional branch on GitHub. Defaults to master. */ export function getCurrentSource(slug, isIndex = false, branch = DEFAULT_BRANCH) { - const ext = isIndex ? '/index.md' : '.md' + const ext = isIndex ? '/index.mdx' : '.mdx' return github(`website/docs${slug}${ext}`, branch) } diff --git a/website/src/widgets/landing.js b/website/src/widgets/landing.js index b7ae35f6e..5f3e39e26 100644 --- a/website/src/widgets/landing.js +++ b/website/src/widgets/landing.js @@ -27,7 +27,7 @@ import prodigyImage from '../../docs/images/prodigy_overview.jpg' import projectsImage from '../../docs/images/projects.png' import tailoredPipelinesImage from '../../docs/images/spacy-tailored-pipelines_wide.png' -import Benchmarks from 'usage/_benchmarks-models.md' +import Benchmarks from '../../docs/usage/_benchmarks-models.mdx' function getCodeExample(nightly) { return `# pip install -U ${nightly ? 'spacy-nightly --pre' : 'spacy'}