Skip to content

Refactor Markdown CMS #36

@dantaeyoung

Description

@dantaeyoung

Currently, the nuxt/content CMS is wonky and prevents proper structuring of data.

Notes for myself:

Goals:

  • Have content stored in Markdown files, in a directory-based structure
  • Have filenames map to slug names (e.g. tutorial-on-gh/intro-to-gh.md maps to tutorial-on-gh/intro-to-gh)
  • Have index.md files that contain data about the directory; e.g. tutorial-on-gh/index.md contains metadata about tutorial-on-gh (for example, correct title data)
  • Potentially allow for infinitely nested directories (e.g. grasshopper/tutorial-on-gh/intro-to-gh.md)
  • Parse through all markdown files to process double-links [[link]], and to generate link graphs
  • Not have github-based user input be cumbersome (e.g. perhaps get rid of moduleID, since then each additional contributor would have to understand what all the existing IDs are to avoid collisions)

Interface:

  • Metadata / CMS structure is exposed via a single object (perhaps in Vuex store)
  • Markdown body itself can still use nuxt/content

Options on how to do this:

  1. A script that scans through all markdown files on build time, and generates a json file that is then loaded by the app (into vuex?
  2. A plugin/module that scans through all markdown files on build time and loads data into Vuex?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions