From e6e90b7cd78fc97ee0cf52a08204e45e09aa6e9b Mon Sep 17 00:00:00 2001 From: dharamveergit Date: Wed, 10 Jan 2024 23:08:09 +0530 Subject: [PATCH] fix: how-to-use-akash-web index.md and Docs --- .../Blog/how-to-use-akash-web/index.md | 60 ++++++++++++++++++- src/pages/blog/[slug].astro | 2 +- tailwind.config.cjs | 1 + 3 files changed, 59 insertions(+), 4 deletions(-) diff --git a/src/content/Blog/how-to-use-akash-web/index.md b/src/content/Blog/how-to-use-akash-web/index.md index 34f60916..9c9d9c82 100644 --- a/src/content/Blog/how-to-use-akash-web/index.md +++ b/src/content/Blog/how-to-use-akash-web/index.md @@ -35,7 +35,10 @@ bannerImage: ./banner-image.png - [How to add Community Edu](#how-to-add-community-edu) - [How to add Community Contributions Card](#how-to-add-community-contributions-card) - [Ecosystem](#ecosystem) -- [How to add card to ecosystem](#how-to-add-card-to-ecosystem) + - [How to add card to ecosystem](#how-to-add-card-to-ecosystem) +- [Docs](#docs) + - [How to change sequence of docs](#how-to-change-sequence-of-docs) + - [How to add new doc in docs or engineering docs](#how-to-add-new-doc-in-docs-or-engineering-docs) ## How to write a blog @@ -145,7 +148,7 @@ description: Greg Osuri, CEO of Overclock Labs and Founder of Akash Network, wil ## Ecosystem -## How to add card to ecosystem +### How to add card to ecosystem 1. Create a new folder under `src/content/Ecosystem_Page/` with the name of the event. For example, `src/content/Ecosystem_Page/akash-chat/` @@ -178,10 +181,61 @@ featured: true --- ``` -5. Showcase is used to show the card in [showcase](/ecosystem/showcase/latest) +5. Showcase is used to show the card in [showcase](/ecosystem/showcase/latest) in ecosystem tag 6. Featured is used to show the card on the top of the page 7. Add the banner image to the same folder as the markdown file. For example, `src/content/Ecosystem_Page/akash-chat/project-banner.png` 8. Commit and push the changes to the repository. The event will be published automatically. + +## Docs + +### How to change sequence of docs + +1. Go to the `src/content/Docs/sequence.ts` +2. Change the sequence of the docs + +```ts +export const docsSequence = [ + { + label: "Docs", + subItems: [ + { + label: "Getting Started", // <--- Change the sequence here + subItems: [ // <--- Change the sequence here + { label: "Intro To Akash" }, // <--- Change the sequence here + { label: "Akash Overview" } + { label: "Stack Definition Language (SDL)" }, + { label: "Tokens and Wallets" }, + ], + }, + } +] +``` + +3. Name of the label should same as rendered name of the doc in the website + +4. Commit and push the changes to the repository. The event will be published automatically. + +### How to add new doc in docs or engineering docs + +1. Create a new folder under `src/content/Docs/docs` or `src/content/Docs/engineering-documentation` with the name of the doc. For example, `src/content/Docs/docs/akash-101/` or `src/content/Docs/engineering-documentation/akash-101/` + +2. Create a new file called `index.md` under the new folder. For example, `src/content/Docs/docs/akash-101/index.md` or `src/content/Docs/engineering-documentation/akash-101/index.md` + +3. Copy the following template into the new file and fill in the details. + +```md +--- +categories: ["Akash Nodes"] # <--- Change the category here +tags: ["Blockchain"] # <--- Change the tag here +weight: 1 # <--- Change the weight here +title: "Akash Node CLI Build" # <--- Change the title here +linkTitle: "Akash Node CLI Build" # <--- Change the link title here +--- +``` + +4. If you want to add sub items, add the folder under the folder of the doc. For example, `src/content/Docs/docs/akash-101/akash-node-cli-build/` + +5. Create a new file called `index.md` under the new folder. For example, `src/content/Docs/docs/akash-101/akash-node-cli-build/index.md` diff --git a/src/pages/blog/[slug].astro b/src/pages/blog/[slug].astro index 9e654a2f..adc5a49d 100644 --- a/src/pages/blog/[slug].astro +++ b/src/pages/blog/[slug].astro @@ -144,7 +144,7 @@ const { Content } = await post.render(); width={1200} height={1200} format="webp" - class="inset-0 aspect-video max-h-[490px] bg-gray-200 object-cover" + class="inset-0 aspect-video bg-gray-200 object-cover" loading="lazy" quality="max" /> diff --git a/tailwind.config.cjs b/tailwind.config.cjs index d11b96f1..45994c9f 100644 --- a/tailwind.config.cjs +++ b/tailwind.config.cjs @@ -37,6 +37,7 @@ module.exports = { paddingRight: theme("spacing[1.5]"), paddingTop: theme("spacing.1"), paddingBottom: theme("spacing.1"), + wordBreak: "break-word", }, strong: { color: "hsl(var(--foreground))",