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

Feat - docusaurus implementation #577

Merged
merged 10 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions .docusaurus/DONT-EDIT-THIS-FOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This folder stores temp files that Docusaurus' client bundler accesses.

DO NOT hand-modify files in this folder because they will be overwritten in the
next build. You can clear all build artifacts (including this folder) with the
`docusaurus clear` command.
6 changes: 6 additions & 0 deletions .docusaurus/client-modules.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default [
require("/Users/fstoqnov/cardano-documentation/node_modules/infima/dist/css/default/default.css"),
require("/Users/fstoqnov/cardano-documentation/node_modules/@docusaurus/theme-classic/lib/prism-include-languages"),
require("/Users/fstoqnov/cardano-documentation/node_modules/@docusaurus/theme-classic/lib/nprogress"),
require("/Users/fstoqnov/cardano-documentation/src/css/custom.css"),
];
1 change: 1 addition & 0 deletions .docusaurus/codeTranslations.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
{
"blogPosts": [
{
"id": "welcome",
"metadata": {
"permalink": "/blog/welcome",
"source": "@site/blog/2021-08-26-welcome/index.md",
"title": "Welcome",
"description": "Docusaurus blogging features are powered by the blog plugin.",
"date": "2021-08-26T00:00:00.000Z",
"formattedDate": "August 26, 2021",
"tags": [
{
"label": "facebook",
"permalink": "/blog/tags/facebook"
},
{
"label": "hello",
"permalink": "/blog/tags/hello"
},
{
"label": "docusaurus",
"permalink": "/blog/tags/docusaurus"
}
],
"readingTime": 0.405,
"hasTruncateMarker": false,
"authors": [
{
"name": "Sébastien Lorber",
"title": "Docusaurus maintainer",
"url": "https://sebastienlorber.com",
"imageURL": "https://github.com/slorber.png",
"key": "slorber"
},
{
"name": "Yangshun Tay",
"title": "Front End Engineer @ Facebook",
"url": "https://github.com/yangshun",
"imageURL": "https://github.com/yangshun.png",
"key": "yangshun"
}
],
"frontMatter": {
"slug": "welcome",
"title": "Welcome",
"authors": [
"slorber",
"yangshun"
],
"tags": [
"facebook",
"hello",
"docusaurus"
]
},
"unlisted": false,
"nextItem": {
"title": "MDX Blog Post",
"permalink": "/blog/mdx-blog-post"
}
},
"content": "[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).\n\nSimply add Markdown files (or folders) to the `blog` directory.\n\nRegular blog authors can be added to `authors.yml`.\n\nThe blog post date can be extracted from filenames, such as:\n\n- `2019-05-30-welcome.md`\n- `2019-05-30-welcome/index.md`\n\nA blog post folder can be convenient to co-locate blog post images:\n\n![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)\n\nThe blog supports tags as well!\n\n**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config."
},
{
"id": "mdx-blog-post",
"metadata": {
"permalink": "/blog/mdx-blog-post",
"source": "@site/blog/2021-08-01-mdx-blog-post.mdx",
"title": "MDX Blog Post",
"description": "Blog posts support Docusaurus Markdown features, such as MDX.",
"date": "2021-08-01T00:00:00.000Z",
"formattedDate": "August 1, 2021",
"tags": [
{
"label": "docusaurus",
"permalink": "/blog/tags/docusaurus"
}
],
"readingTime": 0.175,
"hasTruncateMarker": false,
"authors": [
{
"name": "Sébastien Lorber",
"title": "Docusaurus maintainer",
"url": "https://sebastienlorber.com",
"imageURL": "https://github.com/slorber.png",
"key": "slorber"
}
],
"frontMatter": {
"slug": "mdx-blog-post",
"title": "MDX Blog Post",
"authors": [
"slorber"
],
"tags": [
"docusaurus"
]
},
"unlisted": false,
"prevItem": {
"title": "Welcome",
"permalink": "/blog/welcome"
},
"nextItem": {
"title": "Long Blog Post",
"permalink": "/blog/long-blog-post"
}
},
"content": "Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).\n\n:::tip\n\nUse the power of React to create interactive blog posts.\n\n```js\n<button onClick={() => alert('button clicked!')}>Click me!</button>\n```\n\n<button onClick={() => alert('button clicked!')}>Click me!</button>\n\n:::"
},
{
"id": "long-blog-post",
"metadata": {
"permalink": "/blog/long-blog-post",
"source": "@site/blog/2019-05-29-long-blog-post.md",
"title": "Long Blog Post",
"description": "This is the summary of a very long blog post,",
"date": "2019-05-29T00:00:00.000Z",
"formattedDate": "May 29, 2019",
"tags": [
{
"label": "hello",
"permalink": "/blog/tags/hello"
},
{
"label": "docusaurus",
"permalink": "/blog/tags/docusaurus"
}
],
"readingTime": 2.05,
"hasTruncateMarker": true,
"authors": [
{
"name": "Endilie Yacop Sucipto",
"title": "Maintainer of Docusaurus",
"url": "https://github.com/endiliey",
"imageURL": "https://github.com/endiliey.png",
"key": "endi"
}
],
"frontMatter": {
"slug": "long-blog-post",
"title": "Long Blog Post",
"authors": "endi",
"tags": [
"hello",
"docusaurus"
]
},
"unlisted": false,
"prevItem": {
"title": "MDX Blog Post",
"permalink": "/blog/mdx-blog-post"
},
"nextItem": {
"title": "First Blog Post",
"permalink": "/blog/first-blog-post"
}
},
"content": "This is the summary of a very long blog post,\n\nUse a `<!--` `truncate` `-->` comment to limit blog post size in the list view.\n\n<!--truncate-->\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"
},
{
"id": "first-blog-post",
"metadata": {
"permalink": "/blog/first-blog-post",
"source": "@site/blog/2019-05-28-first-blog-post.md",
"title": "First Blog Post",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet",
"date": "2019-05-28T00:00:00.000Z",
"formattedDate": "May 28, 2019",
"tags": [
{
"label": "hola",
"permalink": "/blog/tags/hola"
},
{
"label": "docusaurus",
"permalink": "/blog/tags/docusaurus"
}
],
"readingTime": 0.12,
"hasTruncateMarker": false,
"authors": [
{
"name": "Gao Wei",
"title": "Docusaurus Core Team",
"url": "https://github.com/wgao19",
"image_url": "https://github.com/wgao19.png",
"imageURL": "https://github.com/wgao19.png"
}
],
"frontMatter": {
"slug": "first-blog-post",
"title": "First Blog Post",
"authors": {
"name": "Gao Wei",
"title": "Docusaurus Core Team",
"url": "https://github.com/wgao19",
"image_url": "https://github.com/wgao19.png",
"imageURL": "https://github.com/wgao19.png"
},
"tags": [
"hola",
"docusaurus"
]
},
"unlisted": false,
"prevItem": {
"title": "Long Blog Post",
"permalink": "/blog/long-blog-post"
}
},
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"permalink": "/blog",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 4,
"blogDescription": "Blog",
"blogTitle": "Blog"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Recent posts",
"items": []
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"permalink": "/blog/tags/docusaurus",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 4,
"blogDescription": "Blog",
"blogTitle": "Blog"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "docusaurus",
"permalink": "/blog/tags/docusaurus",
"allTagsPath": "/blog/tags",
"count": 4,
"unlisted": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"permalink": "/blog/tags/facebook",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 1,
"blogDescription": "Blog",
"blogTitle": "Blog"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "facebook",
"permalink": "/blog/tags/facebook",
"allTagsPath": "/blog/tags",
"count": 1,
"unlisted": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"permalink": "/blog/tags/hello",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 2,
"blogDescription": "Blog",
"blogTitle": "Blog"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "hello",
"permalink": "/blog/tags/hello",
"allTagsPath": "/blog/tags",
"count": 2,
"unlisted": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"permalink": "/blog/tags/hola",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 1,
"blogDescription": "Blog",
"blogTitle": "Blog"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "hola",
"permalink": "/blog/tags/hola",
"allTagsPath": "/blog/tags",
"count": 1,
"unlisted": false
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[
{
"label": "facebook",
"permalink": "/blog/tags/facebook",
"count": 1
},
{
"label": "hello",
"permalink": "/blog/tags/hello",
"count": 2
},
{
"label": "docusaurus",
"permalink": "/blog/tags/docusaurus",
"count": 4
},
{
"label": "hola",
"permalink": "/blog/tags/hola",
"count": 1
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "docusaurus-plugin-content-blog",
"id": "default"
}
Loading
Loading