Published on

Getting Started

Tags

I have only used this project on macOS(Big Sur), hopefully the steps described below will work for you as well. If you are familiar with general Javascript development process, it should feel familiar.

  • Create a new git project to host your content data

This directory should have following sub-directories.files created

  • config/index.js

    this is where all the site metadata go. The supported metadata can be found in this reference

  • content/blog

    this is where you place your blog posts. The underlying implementation is based on nuxt/content. So please refer to Writing Content section on how to use the Markdown for the blog. As of front matter, the required ones are:

    • title
    • description
    • tags (a list)
  • content/other

    this is the place for some special pages. Currently two files are required:

    • home.md
    • about.md
  • static

    this is the place for static content, which includes but not limited to

    • robots.txt
    • favicon.ico

    * you can store images here, but ideally you should use an image service (e.g. flickr.com). I manage my content with git as well. Having a lot of images checked in git is not ideal.

  • Add Tailwind-NuxtJs-Starter-Blog as git submodule to the project

    git submodule add https://github.com/ooasis/tailwind-nuxtjs-starter-blog.git
    

    this will create a sub-directory tailwind-nuxtjs-starter-blog which you will use to generate the static site.

  • to run a local instance which you can live view your editing

    cd tailwind-nuxtjs-starter-blog
    yarn dev
    

    once service is up, you can view the site at:

    http://localhost:3000
    
  • to generate content for static site, run

    tailwind-nuxtjs-starter-blog
    yarn generate
    

    this command will generate the static files to dist