Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write the Documentation #1

Open
3 of 38 tasks
allejo opened this issue May 4, 2017 · 0 comments
Open
3 of 38 tasks

Write the Documentation #1

allejo opened this issue May 4, 2017 · 0 comments
Labels
help wanted

Comments

@allejo
Copy link
Member

allejo commented May 4, 2017 •
edited
Loading

Now, there's a lot of features within stakx but I haven't documented anything yet. So here's what needs to be documented:

  • Site configuration
    • Reserved keywords/functionality
    • How to define everything: collections, target directory, data locations, datasets, pageviews, theme, debug, and build settings
  • Front Matter
    • Variables
    • Special + reserved keys
  • ContentItems + Collections
    • What they are + how to define
    • How to access them
    • Role with dynamic PageViews
  • DataItems + DataSets
    • What they are + how to define
    • How to access them
    • Role with dynamic PageViews
  • PageViews
    • Difference between static, dynamic, and repeater
      • Collection + DataSet
    • Where they should be housed
    • Requirements to be a PageView
  • Permalinks
    • Redirect support for PageViews (string vs array)
    • Variables + "value expansion"
  • Code Highlighting
    • Enable/disable
    • Custom language definitions
    • Porting highlight.js definitions
  • Assets
    • How to handle them
  • Twig
    • Configuration options
    • Link to Twig documentation
    • Built in Twig filters made for stakx
  • Themes
    • configuration file
  • Tutorials
    • Coming from Jekyll
    • Exporting from WordPress
    • Tips + tricks

This list is probably incomplete and I need to add more to it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Milestone
No milestone
Development

No branches or pull requests
1 participant
@allejo