Skip to content

Documentation data #17

Open
Open
@jonschlinkert

Description

@jonschlinkert
Contributor

One of my "design" goals for the new site is to look for opportunities to make data more reusable, whenever possible. For example, our CHANGELOG will be formatted as YAML so that it can be parsed and used in templates. This allows the changelog to be rendered as markdown, HTML, or even pulled down from the GitHub API and consumed by some other application or lib.

I also believe that - if executed well - this will make the site more accessible, scalable and maintainable.

  • changelog: version (object|key), date (string), changes (associative array)
  • language features (todo)

Related

Activity

jonschlinkert

jonschlinkert commented on Aug 2, 2013

@jonschlinkert
ContributorAuthor

@matthew-dean, your thoughts on this would be great.

Also, you mentioned a "docs API", I think this will definitely be achievable in short order. GitHub's api let's you pull down specific documents (.e.g. '/repos/less/less-docs/contents/features.json' or whatever), you just need to set the encoding (probably to utf8) and you're good to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jonschlinkert

        Issue actions

          Documentation data · Issue #17 · less/less-docs