-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
73a28d5
commit edfc9fc
Showing
1 changed file
with
18 additions
and
233 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,247 +1,32 @@ | ||
| <a name="readme-top"></a> | ||
| # Nuxt Content | ||
|
|
||
| <!-- PROJECT SHIELDS --> | ||
| The **Nuxt Content** template contains the configurations for creating a blog or documentation website based on [Nuxt Content](https://content.nuxt.com/). | ||
|
|
||
| [![Contributors][contributors-shield]][contributors-url] | ||
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![MIT License][license-shield]][license-url] | ||
| This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy the Nuxt Content template](https://www.azion.com/en/documentation/products/guides/nuxt-content/) guide. | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="/"> | ||
| <img src="assets/images/nuxt-content.png" /> | ||
| </a> | ||
| This template uses Nuxt `3.0.0`. | ||
|
|
||
| <h3 align="center">Nuxt Content Template</h3> | ||
| > **Note**: this is a community template. Third-party or external developers created it, and Azion only enables the deployment in the Azion Edge Platform. Azion doesn't provide maintenance or support for the content itself but can assist you with any queries or issues you may encounter while deploying this template or using the platform. | ||
| > | ||
| > Join the Azion communities at [GitHub](https://github.com/aziontech) and [Discord](https://discord.com/channels/1112754829878624390/1113104727979348008) to learn, seek advice, and stay updated on trends. | ||
| <p align="center"> | ||
| An opionionated Nuxt.js Template with Nuxt Content! | ||
| <br /> | ||
| <a href="https://nuxt-content-template.netlify.app/"><strong>View Demo »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/data-miner00/nuxt-content-template">Explore the docs</a> | ||
| · | ||
| <a href="https://github.com/data-miner00/nuxt-content-template/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/data-miner00/nuxt-content-template/issues">Request Feature</a> | ||
| </p> | ||
| </div> | ||
| --- | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| <li><a href="#features">Features</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#usage">Usage</a></li> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| </ol> | ||
| </details> | ||
| ## Requirements | ||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| Before using this template, you need to: | ||
|
|
||
| ## About The Project | ||
| - Have a [GitHub account](https://github.com/signup). | ||
| - Every push will be deployed automatically to the main branch in this repository to keep your project updated. | ||
|
|
||
|  | ||
| > **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. | ||
| An extremely opinionated template for building Markdown oriented Nuxt websites with Nuxt Content and TailwindCSS. Focus on the development itself rather than low-level configurations. | ||
| --- | ||
|
|
||
| Incentives: | ||
| ## Deploy your own | ||
|
|
||
| - Wanted to build out my new personal website | ||
| - Want Markdown | ||
| - Want newest version of Vue, Nuxt and Nuxt Content (at the time). | ||
| - Build this multi-purpose template so I can use for other projects. | ||
| Deploy your own Nuxt Content project with Azion. | ||
|
|
||
| Projects that use this template: | ||
| [](https://console.azion.com/create/azion-community/nuxt-content "Deploy with Azion") | ||
|
|
||
| - [notes.mumk.dev](https://notes.mumk.dev) | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### Built With | ||
|
|
||
| The technologies and tools used within this template. | ||
|
|
||
| - Vue | ||
| - Nuxt | ||
| - Nuxt Content | ||
| - TailwindCSS | ||
| - TypeScript | ||
|
|
||
| The version for Nuxt (3.6.1) and Nuxt Content (2.7.0) must remain. Updating the version for these two packages will break the static site generation. Regardless, the existing version in my humble opinion is good enough to create a functional documentation/blogs. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### Features | ||
|
|
||
| This template currently offers the following features. For more info, please read the [guide](https://nuxt-content-template.netlify.app/guide). | ||
|
|
||
| - Markdown articles | ||
| - Markdown embeddable LaTeX (`rehype-mathjax`, `remark-math`) | ||
| - Math Equations | ||
| - [Chemical Equations](https://notes.mumk.dev/articles/general/latex#chemical-equations) | ||
| - Internationalization (i18n, `@nuxtjs/i18n`) | ||
| - Dark Mode (`@nuxtjs/color-mode`) | ||
| - Mobile responsive | ||
| - Styling with TailwindCSS | ||
| - Static-site generation | ||
| - Simple SEO (`nuxt-seo-kit`) | ||
| - Auto-generated Sitemap.xml | ||
| - robots.txt | ||
| - Optimized site metadata | ||
| - Image optimization (`@nuxt/image`) | ||
| - Vue utilities | ||
| - Powerful hooks (`@vueuse/core`) | ||
| - Animation (`@vueuse/motion`) | ||
| - 404 Page (the `/resource` url does not exist) | ||
| - Ultra-fast loading speed | ||
| - Support for Node 18 and Node 20 | ||
| - Typo checking (need to install from [crates-ci/typos](https://github.com/crate-ci/typos)) | ||
| - Sass support (although I don't remember using it 😁) | ||
|
|
||
| Again, if you wish to grok what this template is capable of, consider visiting [my technical blog](https://notes.mumk.dev) to see it for yourself. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- GETTING STARTED --> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| The list of tools that is used when development. | ||
|
|
||
| - npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
| - Pnpm | ||
| ```sh | ||
| npm i -g pnpm | ||
| ``` | ||
| - [Git](https://git-scm.com/downloads) | ||
|
|
||
| ### Installation | ||
|
|
||
| To run this template project in your local for personal use or contribution, simply perform the following. | ||
|
|
||
| 1. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/data-miner00/nuxt-content-template.git | ||
| ``` | ||
| 2. Install Node dependencies | ||
| ```sh | ||
| pnpm i | ||
| ``` | ||
| 3. Start the development server | ||
| ```sh | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| > ⚠️ Important: **Do not update** the dependencies as it will break due to incompatibilities from the latest Nuxt and Nuxt Content. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- ROADMAP --> | ||
|
|
||
| ## Roadmap | ||
|
|
||
| - [x] Add Dark Mode | ||
| - [x] Add i18n | ||
| - [x] Add Styling | ||
| - [x] Sass | ||
| - [x] Tailwind | ||
| - [ ] Add PWA Manifest | ||
| - [x] Responsive styles | ||
| - [ ] DocSearch | ||
| - [x] Copy code block button | ||
| - [ ] Add line numbers to code block | ||
| - [x] Add highlight to code block | ||
| - [ ] Add missing items to mobile navbar | ||
|
|
||
| See the [open issues](https://github.com/data-miner00/nuxt-content-template/issues) for a full list of proposed features (and known issues). | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". | ||
| Don't forget to give the project a star! Thanks again! | ||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| <!-- LICENSE --> | ||
| ## License | ||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| <!-- ACKNOWLEDGMENTS --> | ||
| ## Acknowledgments | ||
| List of resources that are helpful and would like to give credit to. | ||
| - [Vue.js v3](https://vuejs.org/) | ||
| - [Nuxt v3](https://nuxt.com/) | ||
| - [Nuxt Content](https://content.nuxtjs.org) | ||
| - [Robots.txt](https://developers.google.com/search/docs/crawling-indexing/robots/intro) | ||
| - [enji.dev](https://www.enji.dev/) | ||
| - [How to Create a Custom Code Block With Nuxt Content v2](https://mokkapps.de/blog/how-to-create-a-custom-code-block-with-nuxt-content-v2/) | ||
| - [VueUse](https://vueuse.org/) | ||
| - [@nuxtjs/color-mode](https://color-mode.nuxtjs.org/) | ||
| - [Nuxt Tailwind](https://tailwindcss.nuxtjs.org/) | ||
| - [How to add class attribute to the body tag in NuxtJs](https://postsrc.com/code-snippets/how-to-add-class-attribute-to-the-body-tag-in-nuxtjs) | ||
| - [Nuxt i18n](https://v8.i18n.nuxtjs.org/) | ||
| - [How to Build a Multi-Language Application with NuxtJS](https://crowdin.com/blog/2023/01/24/nuxt-js-i18n-tutorial) | ||
| - [Vue i18n](https://vue-i18n.intlify.dev/) | ||
| - [Nuxt Seo Kit](https://github.com/harlan-zw/nuxt-seo-kit) | ||
| - [Nuxt Image](https://image.nuxtjs.org/) | ||
| - [Nuxt UI](https://ui.nuxt.com/) | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/data-miner00/nuxt-content-template.svg?style=for-the-badge | ||
| [contributors-url]: https://github.com/data-miner00/nuxt-content-template/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/data-miner00/nuxt-content-template.svg?style=for-the-badge | ||
| [forks-url]: https://github.com/data-miner00/nuxt-content-template/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/data-miner00/nuxt-content-template.svg?style=for-the-badge | ||
| [stars-url]: https://github.com/data-miner00/nuxt-content-template/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/data-miner00/nuxt-content-template.svg?style=for-the-badge | ||
| [issues-url]: https://github.com/data-miner00/nuxt-content-template/issues | ||
| [license-shield]: https://img.shields.io/github/license/data-miner00/nuxt-content-template.svg?style=for-the-badge | ||
| [license-url]: https://github.com/data-miner00/nuxt-content-template/blob/master/LICENSE | ||
| For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/nuxt-content/). |