https://github.com/davidroyer/nuxt-markdown-example

An example of using markdown files for content with Nuxt.js / Vue.js
https://github.com/davidroyer/nuxt-markdown-example

demo example nuxt nuxtjs vue vuejs

Last synced: about 1 month ago
JSON representation

An example of using markdown files for content with Nuxt.js / Vue.js

• Host: GitHub
• URL: https://github.com/davidroyer/nuxt-markdown-example
• Owner: davidroyer
• Created: 2017-06-26T02:21:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-27T01:51:29.000Z (over 7 years ago)
• Last Synced: 2024-11-04T10:43:57.935Z (about 1 month ago)
• Topics: demo, example, nuxt, nuxtjs, vue, vuejs
• Language: Vue
• Homepage: https://nuxt-markdown-example.netlify.com/
• Size: 240 KB
• Stars: 48
• Watchers: 3
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - davidroyer/nuxt-markdown-example - An example of using markdown files for content with Nuxt.js / Vue.js (vuejs)

README

        
# nuxt-markdown-example

> An example of using markdown files for content with Nuxt.js / Vue.js

The markdown files for this example live in the directory **markdownFiles**, inside the **static** folder.

They are imported using webpack's import capability and loadered with the markdown-it module via [Nuxt.js modules](https://github.com/nuxt-community/modules).

This content you are reading at this very moment is actually a markdown file. It's titled home.md and can find it in the **markdownFiles** directory.

Inside the **markdownFiles** directory, you will find 2 other files

- test1.md

- test2.md

They are used to show the dynamic import ability of webpack and that can be seen in **dynamic/_slug.vue**

## Build Setup

``` bash

# install dependencies

$ npm install # Or yarn install

# serve with hot reload at localhost:3000

$ npm run dev

# build for production and launch server

$ npm run build

$ npm start

# generate static project

$ npm run generate

```

For detailed explanation on how things work, checkout the [Nuxt.js docs](https://github.com/nuxt/nuxt.js).