https://github.com/nguyenanhtuan1912/deploy-on-cloud-workshop

Learn how to deploy a simple server / web application on cloud
https://github.com/nguyenanhtuan1912/deploy-on-cloud-workshop

aws aws-workshops

Last synced: 14 days ago
JSON representation

Learn how to deploy a simple server / web application on cloud

• Host: GitHub
• URL: https://github.com/nguyenanhtuan1912/deploy-on-cloud-workshop
• Owner: NguyenAnhTuan1912
• License: mit
• Created: 2024-10-21T16:13:05.000Z (27 days ago)
• Default Branch: main
• Last Pushed: 2024-10-25T14:50:38.000Z (23 days ago)
• Last Synced: 2024-11-03T17:04:39.810Z (14 days ago)
• Topics: aws, aws-workshops
• Language: MDX
• Homepage: https://deploy-on-cloud-workshop.vercel.app
• Size: 9.58 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Build a documentation site with Weminal Template using Nextra

You can view at Readme File or [Notion Site](https://shadow-eagle-469.notion.site/Build-a-documentation-site-with-Weminal-Template-using-Nextra-ddb5af4b8a5546c99a5ad8fa0557850c?pvs=4) to gain this knowledge 

![image.png](/public/readme_assets/image.png)

## 1. What is Nextra?

According to [Nextra.site](https://nextra.site/docs), Nextra is a framework on top of Next.js that lets you build content-focused websites. It has all the great features from Next.js, plus extra power to create Markdown-based content with ease.

You can read about Nextra here: [More about Nextra](https://nextra.site/).

With Nextra, you can create a full-blown documentation site with search functionality, syntax highlighting, embedding React components into MDX files, and more.

Some companies that use Nextra for their documentation sites include [Next.js](https://nextjs.org/), [React](https://reactjs.org/), [Tailwind](https://tailwindcss.com/), [Node.js](https://nodejs.org/en), [CodeSandbox](https://codesandbox.io/docs/learn/introduction/overview) and more.

## 2. Features of Nextra

- Light and dark mode theme.

- Advanced syntax highlighting for code snippets.

- Ability to use React components in markdown files.

- Full-text search functionality.

## 3. Getting Started With Weminal Document Template

A ready-made template for a documentation site is available on [Weminal’s template repository](https://github.com/Weminal-labs/document-template). So you have to create the repository from this template.

Now, in [Weminal’s template repository](https://github.com/Weminal-labs/document-template), click button `Use this template`:

![image_1.png](/public/readme_assets/image_1.png)

You need to fill some necessary information like this:

![image_2.png](/public/readme_assets/image_2.png)

Repository was created!

![image_3.png](/public/readme_assets/image_3.png)

You can clone this repository into your local machine by 

```jsx

git clone your_repo

```

Once you've cloned the git repository on your machine, you should have a folder structure like this:

![image_4.png](/public/readme_assets/image_4.png)

Now that you've cloned the repository navigate into the project directory and install the dependencies:

```jsx

npm install

```

When the installation is complete, start the local development server by running the following:

```jsx

npm run dev

```

![image.png](/public/readme_assets/image.png)

🎉 Tada! You done 🎉