diff options
Diffstat (limited to 'content/README')
| -rw-r--r-- | content/README | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/content/README b/content/README new file mode 100644 index 0000000..30e149c --- /dev/null +++ b/content/README @@ -0,0 +1,27 @@ +This directory holds Go blog articles, in *.article. +See https://pkg.go.dev/golang.org/x/tools/present?tab=doc +for documentation of the file format or look at any of the +articles for examples. + +Article file names should be short, amenable to being typed by hand in URLs. +Typically article file names are up to three words, separated by dashes. +A trailing year in the name typically does not have a dash before it. + +All supporting files for an article, even if there's only one, should be +placed in a directory named for the article (minus the .article suffix). + +If your article has code that is meant to be a working program, please use +.code, or ideally .play, to load the lines from a supporting .go file. +That way you can easily check that the .go file, and therefore the code +in your article, still works. + +Please use .image and .video to embed images and videos, +instead of using raw HTML tags. The .image and .video commands +provide a way to adjust the implementation of those embeddings +all in one place. + +Please use .html when it is necessary to add large blocks of HTML, +keeping article text in the main .article file. Another important use of +.html is to factor out an HTML snippet that appears multiple times. +Short HTML sequences, like <div><center> or </div></center>, +are fine to put directly in the article files. |