diff --git a/README.md b/README.md index ada44e3..ae4b20d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ -# Markdown @Edge +# Markdown@Edge -A Markdown renderer on the Compute @Edge platform from Fastly! +A Markdown renderer on the Compute@Edge platform from Fastly. + +The main source file, `src/main.rs`, contains all the code for the renderer. +The header and footer files I use are included at `content/_header.md` and +`content/_footer.md` for easy inspection. + +## Nginx Configuration + +In order to best support this application, it's important to add the following +line to Nginx's MIME types configuration: + +```text +text/markdown md; +``` + +I also disabled gzip and set the max-age and cache-control headers as follows: + +```nginx +server { + # ... + location /edgeblog { + # To illustrate the source to visitors. + autoindex on; + autoindex_exact_size off; + autoindex_format html; + autoindex_localtime on; + + # To facilitate tagging. + gzip off; + + # Cache-Control headers + expires 1h; + add_header Cache-Control "public"; + } +} +``` diff --git a/content/_footer.md b/content/_footer.md new file mode 100644 index 0000000..2e10c8f --- /dev/null +++ b/content/_footer.md @@ -0,0 +1,10 @@ + +--- +
+ +Created by [Leonora Tindall](./author.md) +| [Code](https://git.nora.codes/nora/edgeblog) +| [Blog](https://nora.codes) +| [Fastly](https://fastly.com) + +
diff --git a/content/_header.md b/content/_header.md new file mode 100644 index 0000000..3a00321 --- /dev/null +++ b/content/_header.md @@ -0,0 +1,38 @@ + + +Markdown@Edge + +

Markdown@Edge

+ +--- +