https://github.com/marinaaisa/nuxt-markdown-blog-starter

Nuxt + Markdown blog starter
https://github.com/marinaaisa/nuxt-markdown-blog-starter

blog markdown nuxt nuxt-template

Last synced: about 1 month ago
JSON representation

Nuxt + Markdown blog starter

• Host: GitHub
• URL: https://github.com/marinaaisa/nuxt-markdown-blog-starter
• Owner: marinaaisa
• License: mit
• Created: 2019-05-09T05:23:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-01T07:24:53.000Z (almost 2 years ago)
• Last Synced: 2024-09-18T17:15:25.982Z (about 2 months ago)
• Topics: blog, markdown, nuxt, nuxt-template
• Language: CSS
• Homepage: https://nuxt-markdown-blog-starter.netlify.com/
• Size: 23.2 MB
• Stars: 568
• Watchers: 16
• Forks: 131
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  

  +

  





  Nuxt + Markdown blog starter





  This is not an official project. It's made by Marina Aísa and you can contribute submitting a pull-request.

  



## ⚡️ Live

[Check it live](https://nuxt-markdown-blog-starter.netlify.com/)

## ✨ Quick start

1.  **Clone this repository.**

    ```sh

    git clone https://github.com/marinaaisa/nuxt-markdown-blog-starter.git

    ```

2.  **Start developing.**

    Navigate into your new site’s directory and start it up.

    ```sh

    cd nuxt-markdown-blog-starter/

    npm install

    npm run dev

    ```

3.  **Running!**

    Your site is now running at `http://localhost:3000`!

## 🧐 What's inside?

    .

    ├── node_modules

    ├── assets

    ├── components

    ├── contents

      ├── en

        ├── blog

        ├── blogsEn.js

      ├── es

        ├── blog

        ├── blogsEs.js

    ├── layouts

    ├── locales

    ├── pages

    ├── plugins

    ├── static

    ├── .gitignore

    ├── LICENSE

    ├── nuxt.config.js

    ├── package-lock.json

    ├── package.json

    └── README.md

1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2.  **`/assets`**: You will find the images and assets for the project. You can find more information at [Nuxt's assets directory documentation](https://nuxtjs.org/guide/assets/)

3.  **`/components`**: Vue components for the project. You can find more information at [Nuxt's components directory documentation](https://nuxtjs.org/guide/directory-structure#the-components-directory)

4.  **`/contents`**: You will save your MD files here. They are divided by language and you will have to write the URL name of each of them at `blogsEn.js` and `blogsEs.js`.

5.  **`/layouts`**: You can find information at [Nuxt's layout directory documentation](https://nuxtjs.org/guide/directory-structure#the-layouts-directory)

6.  **`/locales`**: You will save your translations here.

7.  **`/pages`**: You can find information at [Nuxt's pages directory documentation](https://nuxtjs.org/guide/directory-structure#the-pages-directory)

8.  **`/plugins`**: You can find information at [Nuxt's plugins directory documentation](https://nuxtjs.org/guide/directory-structure#the-plugins-directory)

9.  **`/statics`**: You can find information at [Nuxt's statics directory documentation](https://nuxtjs.org/guide/directory-structure#the-static-directory)

10. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.

11. **`LICENSE`**: This is licensed under the MIT license.

12. **`nuxt-config.js`**: This is the main configuration file for a Nuxt site. This is where you can specify information about your site (metadata) like the site title and description, which Nuxt plugins you’d like to include, etc. (Check out the [config docs](https://nuxtjs.org/guide/configuration) for more detail).

13. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**

14. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

15. **`README.md`**: A text file containing useful reference information about your project.

## 💫 Deploy

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/marinaaisa/nuxt-markdown-blog-starter)