ethanblake4 / anvil Goto Github PK

@bsutton and I discussed and came up with this syntax (in Dart, other languages would be similar):

void myFunction() {
  var x = doThing();
  // [anvil:snippet:"mysnippet"]
  var y = doOther(x);
  y += 5;
  // [anvil:endsnippet]
}

Then in the config:

...
snippets:
- https://github.com/ethanblake4/anvil.git

This would add to the template data so could be accessed like so:

{% code dart %}
{{ snippets.anvil.mysnippet }}
{% endcode %}

or perhaps even:

{% snippet anvil.mysnippet %}

and we could infer the source type.

For docs we need to generate a tree structure of all the pages that is accessible by Jinja. The leaves should have the page metadata like title and URL. We also need to be able to define the order of the pages.

We also need to provide relative access; requirements currently are only the next and previous page relative to the current one, but if it's easy to provide generalized relative access then we can do that.

We need a way to define the 'root' of this relative access list so that we don't end up falling off the entire Docs page via a Previous link on the first docs page or a Next link on the last docs page.