\n \n \n \n {{ content }}\n \n {% if not site.page.notoc %}\n \n {% endif %}\n \n
\n\n\n"
},
{
"path": "docs/pages/templates/404.html",
"content": "---\ntitle: 404\npermalink: /404.html\nlayout: default\n---\n\nThis page does not exist. Go back to the homepage.
\n" }, { "path": "docs/pages/templates/archives.md", "content": "---\ntitle: Date, Category, and Tag Archives\nlayout: default\npermalink: /archives/\n---\n\nAurora has support built-in for generating date, category, and tag archives. These are useful for blogs.\n\n## Date Archives\n\nAurora automatically generates date archives for blog posts. You do not need to configure any setting to use this feature.\n\nDate archives are generated as follows:\n\n- `https://example.com/2024/`: All posts published in 2024.\n- `https://example.com/2024/01/`: All posts published in January 2024.\n- `https://example.com/2024/01/01/`: All posts published on January 1, 2024.\n\n## Category and Tag Archives\n\nAurora automatically generates category and tag archives.\n\nThese archives are generated if you specify `category` and/or `tag` attributes in your blog post front matters.\n\nCategory archives are generated as follows:\n\n- `https://example.com/category/SITE_STATE = {\n \"category_slug_root\": \"categories\",\n \"tag_slug_root\": \"tags\",\n}Aurora has out-of-the-box features designed for use with blogs.
\n\nWrite a Blog Post
\n\nTo use Aurora as a blog, create a markdown file with the following name structure in your pages/posts directory:
YYYY-MM-DD-title.mdFor example, 2020-01-01-hello-world.md.
Within this file, you can specify front matter and, optionally, jinja2 templating.
\n\nHere is an example:
\n\n---\ntitle: Hello, World!\nlayout: post\n---\n\nThis is our first blog post.\nThis will be rendered as a blog post using the \"pages/_layouts/post.html\" file.
\n\nAurora automatically turns your permalink into a URL. For example, the above file will be available at https://example.com/2020/01/01/hello-world/.
Categories and Tags
\n\nAurora can automatically generate archive pages for categories and tags.
\n\nCategories and tags are treated as two separate collections.
\n\nTo use this feature, you need to give at least one blog post a category or a tag, like so:
\n\n---\ntitle: Hello, World!\nlayout: post\ncategories:\n - Announcement\n---\n\nThis is our first blog post.\nCategories and tags are not case-sensitive.
\n\nYou then need to specify either a category or tag layout file, depending on which you want to support.
\n\nTo do so, create a file called category.html or tag.html in your pages/_layouts directory.
This file will have access to a page.posts variable that lists all posts in the category or tag.
Here is an example of a category layout file:
\n\n{% raw %}\n\n---\nlayout: default\ntitle: "Category Archive"\n---\n\n<ul>\n {% for post in page.posts %}\n <li>\n <a href="{{ post.url }}">{{ post.title }}</a>\n </li>\n {% endfor %}\n</ul>\nIn this example, a page at /category/announcement/index.html will be generated.
Date Archives
\n\nAurora can automatically generate date pages for categories and tags.
\n\nDate archives show all posts published on a specific day.
\n\nThere is not currently support for month-based or year-based archives.
\n\nTo use this feature, you need to have at least one blog post.
\n\nYou then need to specify a date archive layout.
\n\nTo do so, create a file called date.html in your pages/_layouts directory.
This file will have access to a page.posts variable that lists all posts published on a specific day.
Here is an example of a category layout file:
\n\n{% raw %}\n\n---\nlayout: default\ntitle: "Date Archive"\n---\n\n<ul>\n {% for post in page.posts %}\n <li>\n <a href="{{ post.url }}">{{ post.title }}</a>\n </li>\n {% endfor %}\n</ul>\nIn this example, a page at /2024/01/01/index.html will be generated, which lists one entry: the hello world post we wrote earlier in this guide.
Now you have a blog set up with Aurora! ๐
\n" }, { "path": "docs/pages/templates/build-methods.md", "content": "---\ntitle: Build Methods\npermalink: /build-methods/\nlayout: default\n---\n\nThere are three ways you can build your Aurora site:\n\n1. Full build\n2. Incremental build\n3. Interactive, incremental build\n\n## Full Build\n\nA full build generates your entire website.\n\nYour site is saved in `_site`, ready for serving.\n\nTo build your site, navigate to the root directory of your project (the folder with the `config.py` file in it), and run:\n\naurora buildaurora build --incrementalTip: Incremental builds support CSV and JSON data files.
\n\n## Interactive, Incremental Build\n\nAn interactive, incremental build generates your full site. It starts a web server through which you can preview pages. When you make a change to any file, the changed file -- and its dependencies -- are re-built and made available over the server. Any open browser tabs that are viewing the site will automatically refresh to show the changes.\n\nThis mode is intended for development. With interactive, incremental building, you can see changes to your site as you make them, without having to wait for your full site to build, and without having to manually refresh your browser.\n\nTo run an interactive, incremental build, navigate to the root directory of your project and run:\n\naurora serveNote: The interactive server should not be used in production.
\n" }, { "path": "docs/pages/templates/collections-from-data.html", "content": "---\ntitle: Create a Collection from Data\npermalink: /collections-from-data/\nlayout: default\n---\n\nYou can turn data from JSON and CSV files into web pages.
\n\n This is useful if you have a data set that you want to turn into a website.\n
\n\n For example, you could export a list of coffee shops you have visited from a\n spreadsheet and turn the list into a static website.\n
\nCreate a Collection
\nJSON
\n\n To create a collection from a JSON file, add a new file to your site's\n pages/_data directory. This file should have a\n .json extension.\n
Within the file, create a list that contains JSON objects, like this:
\n[\n {\n \"slug\": \"rosslyn-coffee\",\n \"layout\": \"coffee\",\n \"title\": \"Rosslyn Coffee in London is terrific.\"\n }\n]\n\n This file is called\n pages/_data/coffee.json.\n
\n Every entry must have a layout key. This corresponds\n with the name of the template that will be used to render the page. For\n example, the coffee layout will be rendered using the\n pages/_layouts/coffee.html template.\n
\n Every entry must also have a slug key. This corresponds\n with the name of the page that will be generated. In the case above, one\n file will be created in the _site output directory:\n _site/coffee/rosslyn-coffee/index.html.\n
CSV
\n\n To create a collection from a CSV file, add a new file to your site's\n pages/_data directory. This file should have a\n .json extension.\n
Here is an example CSV file:
\nslug,layout,title\nrosslyn-coffee,coffee,Rosslyn Coffee in London is terrific.\n\n Your CSV file must have a header row that contains the keys for each entry.\n
\n\n This file is called\n pages/_data/coffee.csv.\n
\n Every entry must have a layout key. This corresponds\n with the name of the template that will be used to render the page. For\n example, the coffee layout will be rendered using the\n pages/_layouts/coffee.html template.\n
\n Every entry must also have a slug key. This corresponds\n with the name of the page that will be generated. In the case above, one\n file will be created in the _site output directory:\n _site/coffee/rosslyn-coffee/index.html.\n
Create a Collection
\nJSON
\n\n To create a collection from a JSON file, add a new file to your site's\n pages/_data directory. This file should have a\n .json extension.\n
Within the file, create a list that contains JSON objects, like this:
\n[\n {\n \"slug\": \"rosslyn-coffee\",\n \"layout\": \"coffee\",\n \"title\": \"Rosslyn Coffee in London is terrific.\"\n }\n]\n\n This file is called\n pages/_data/coffee.json.\n
\n Every entry must have a layout key. This corresponds\n with the name of the template that will be used to render the page. For\n example, the coffee layout will be rendered using the\n pages/_layouts/coffee.html template.\n
\n Every entry must also have a slug key. This corresponds\n with the name of the page that will be generated. In the case above, one\n file will be created in the _site output directory:\n _site/coffee/rosslyn-coffee/index.html.\n
CSV
\n\n To create a collection from a CSV file, add a new file to your site's\n pages/_data directory. This file should have a\n .csv extension.\n
Here is an example CSV file:
\nslug,layout,title\nrosslyn-coffee,coffee,Rosslyn Coffee in London is terrific.\n\n Your CSV file must have a header row that contains the keys for each entry.\n
\n\n This file is called\n pages/_data/coffee.csv.\n
\n Every entry must have a layout key. This corresponds\n with the name of the template that will be used to render the page. For\n example, the coffee layout will be rendered using the\n pages/_layouts/coffee.html template.\n
\n Every entry must also have a slug key. This corresponds\n with the name of the page that will be generated. In the case above, one\n file will be created in the _site output directory:\n _site/coffee/rosslyn-coffee/index.html.\n
---\ntitle: My Page\ncollections: coffee\n---{% raw %}{% for item in coffee %}{% endraw %}\n {{ item.title }}\n{% raw %}{% endfor %}{% endraw %}\n You need a config.py file in the directory in which you will\n build your Aurora site. This file is automatically generated when you run\n aurora new [site-name].\n
\n This configuration file defines a few values that Aurora will use when\n processing your website.\n
\n\n Here is the default config.py file, with accompanying comments:\n
import os\n\nBASE_URLS = {\n \"local\": os.getcwd(),\n}\n\nSITE_ENV = os.environ.get(\"SITE_ENV\", \"local\")\nBASE_URL = BASE_URLS[SITE_ENV]\nROOT_DIR = \"pages\" # where your site pages are\nLAYOUTS_BASE_DIR = \"_layouts\" # where your site layouts are stored\nSITE_DIR = \"_site\" # the directory in which your site will be saved\nHOOKS = {} # used to register hooks (see Hooks documentation for details)\nSITE_STATE = {}Base URLs
\n\n The BASE_URLS dictionary is used to define the base URL for\n your site. This is useful if you want to maintain multiple environments for\n your site (e.g., local, staging, production).\n
\n Here is an example configuration of a site that has a local and staging\n environment:\n
\nBASE_URLS = {\n \"production\": \"https://jamesg.blog\",\n \"staging\": \"https://staging.jamesg.blog\",\n \"local\": os.getcwd(),\n}\nSee Also
\n\n\n" }, { "path": "docs/pages/templates/dates.html", "content": "---\nlayout: default\ntitle: Date Handling\npermalink: /dates/\n---\n\nAurora has several default filters that you can use to handle dates.
\n\n- \n
- long_date - Converts a date to a long format, e.g. \"January 01, 2020\" \n
- date_to_xml_string - Converts a date to an XML string, e.g. \"2020-01-01T00:00:00\" \n
- archive_date - Converts a date to a format suitable for archivess, e.g. \"2020/01\" \n
- month_number_to_written_month - Converts a month number to a written month, e.g. \"01\" to \"January\" \n
These filters can be used like:
\n\n{% raw %}{{ date | long_date }}\n{{ date | date_to_xml_string }}\n{{ date | archive_date }}\n{{ date | month_number_to_written_month }}{% endraw %}I have written several blog posts that explore the design, inspiration, and development of Aurora.
\n\nSee a list of these posts below.
\n\n- \n
- Announcing Aurora \n
- Implementing Incremental Static Regeneration in Aurora \n
- Designing Aurora, a new static site generator \n
\n You can define custom functions that are run before a file is processed by\n Aurora. You can use this feature to save metadata about a page that can then\n be consumed by a template.\n
\nThese functions are called "hooks".
\nThere are three types of hooks, which run:
\n- \n
- As a jinja2 filter you can access on all pages (
template_filtershook) \n - Immediately before a page is generated (
pre_generationhook) \n - After your site has built (
post_buildhook)\n
To define a hook, you need to:
\n- \n
- Write a hook function with the right type signature, and; \n
- \n Add the hook function to the\n
HOOKSdictionary in yourconfig.pyfile.\n \n
Below are instructions on how to define each type of hook.
\n\nFilter Hooks
\n\nFilter hooks are registered as a jinja2 filter.
\n\nThese hooks are useful for manipulating specific values in a template (i.e. formatting dates, changing text).
\n\nThe type signature of this hook is:
\n\n\ndef hook_name(text: str) -> str:\n return text.upper()\nYou can register this hook in the template_filter hook:
\nHOOKS = {\n \"template_filter\": {\n \"example\": [\"hook_name\"]\n }\n}\nThis hook can then be used in any template on your website:
\n\n\n<h1> \"hello world\" | hook_name </h1>\nPre-Generation Hooks
\n\nPre-generation hooks run immediately before a page is generated.
\n\nThese hooks are useful for adding state to a page for use in rendering (i.e. loading link prveiews from a cache, calculating reading times.)
\n\nThe type signature of this hook is:
\n\n\ndef hook_name(file_name: str, page_state: dict, site_state: dict) -> dict:\n return page_state\nYou can register this hook in the template_filter hook:
\nHOOKS = {\n \"pre_generation\": {\n \"example\": [\"hook_name\"]\n }\n}\nPost-Build Hooks
\n\nPost-build hooks run after your site has been built.
\n\nThese hooks are useful for performing actions after your site has been built (i.e. saving a log of last generation time, invoking CSS/JS minification).
\n\nThe type signature of this hook is:
\n\n\ndef hook_name(site_state: str) -> None:\n pass\nYou can register this hook in the template_filter hook:
\nHOOKS = {\n \"post_build\": {\n \"example\": [\"hook_name\"]\n }\n}\nAurora is a static site generator implemented in Python.
\nWith Aurora, you can generate thousands of static web pages in seconds.
\nAurora supports:
\n- \n
- Static generation, with support for jinja2 logic \n
- Incremental Static Regeneration (ISR) with hot reloading \n
- Markdown and HTML content \n
- Generating pages from CSV and JSON files \n
Aurora is open source, and licensed under an MIT license.
\nBuild your first website with Aurora.
\n\nDemo
\n\n\n" }, { "path": "docs/pages/templates/pagination.md", "content": "---\ntitle: Pagination\nlayout: default\npermalink: /pagination/\n---\n\nYou can generate pagination pages for collections.\n\nThis is ideal if you have a collection with many items that you want to split into multiple pages for ease of navigation.\n\n## Usage\n\nTo set up pagination, first [create a collection](/collections/).\n\nThen, create a new layout in your `_layouts` directory. This layout will be used to generate the pagination pages.\n\nThis page can access the `page.___` variable, where `___` is the name of the collection (i.e. `page.books` would reference the `page.books` collection). This variable is an array of all the items in a given page in the collection.\n\nTo see the current page number, reference the `page.page_number` variable.\n\nFinally, add a `paginators` key to the `SITE_STATE` value in your `config.py` file:\n\nSITE_STATE = {\n \"paginators\": {\n \"books\": {\n \"per_page\": 10,\n \"template\": \"books\"\n }\n }\n}\n In a test generating 292,884 files from a CSV file with a single layer of\n inheritance in each template, Aurora built the website in 140.59 seconds\n (2m:20s).\n
\n\n In a test on a website with 1,763 files and multiple layers of inheritance,\n Aurora built the website in 3.149s. The files in this test were a\n combination of blog posts, static pages, and programmatic archives for blog\n posts (date pages, category pages).\n
\n\n In a test rendering 4,000 markdown files with a single layer of inheritance\n in each template, Aurora built the website in between 0.9 and 1.2 seconds.\n
\n\n In a test comparing 11ty to Aurora in generating the\n Airport Pianos\n website (~45 pages), 11ty took 1.36 seconds to start and generate the site,\n whereas Aurora took 0.034 seconds.\n
\n" }, { "path": "docs/pages/templates/permalinks.html", "content": "---\ntitle: Set a Permalink\nlayout: default\npermalink: /permalinks/\n---\n\nYou can define custom permalinks for a page in its front matter.
\n\nTo do so, specify the permalink key:
\n\n---\ntitle: Book List\npermalink: /books/\nlayout: default\n---The page above will be generated with the path /books/.
robots.txt files let you tell search engines which pages they can and can't index.
\n\nTo define a robots.txt file, create a file called robots.txt in your pages/templates/ directory.
Here's an example of a robots.txt file that lets all bots crawl all pages, and points to your sitemap for reference:
\n\nUser-agent: *\nAllow: /\n\nSitemap: /sitemap.xml\nSee Also
\n\n\n" }, { "path": "docs/pages/templates/sitemap.html", "content": "---\ntitle: Set a Sitemap\nlayout: default\n---\n\nTo define a sitemap, create a file called sitemap.xml in your pages/templates/ directory and add the following code:
{% raw %}<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n {% for page in site.pages %}\n {% if not page.noindex %}\n <url>\n <loc>\n {{ page.url }}\n </loc>\n <lastmod>{{ site.build_time }}</lastmod>\n </url>\n {% endif %}\n {% endfor %}\n</urlset>{% endraw %}Learn how to create a website with Aurora.
\n\nInstall Aurora
\nFirst, install Aurora:
\npip3 install aurora-ssg\nCreate a Site
\nTo create a new site, run the following command:
\naurora new my-site\ncd my-site\n\n This will create a folder called\n my-site with everything you need to start your Aurora site.\n
There are two ways to run Aurora:
\n- \n
- aurora build: This command builds your site into a folder called
_site, which you can view on your file system. \n - aurora serve: This command builds your site and starts a local server at
http://localhost:8000on which your site will run. This is ideal for development. \n
To see your site locally, run:
\naurora serve\n This will start a local server at\n http://localhost:8000 on which your site will run.\n
![\"A](\"/assets/newsite.png\")
\n\nWhen you are ready to publish your site, you can run:
\naurora buildThis will build your site into a folder called _site, which you can then upload to a web server.
You have started an Aurora website ๐.
\n\n Next up:\n Add a page to your website.\n
\n" }, { "path": "docs/pages/templates/state.html", "content": "---\ntitle: State\npermalink: /state/\nlayout: default\n---\n\nThere are three types of state in Aurora: page, post and site.
\n\nPage State
\n\nPage state stores values that are only available on that page.
\n\nFor example, consider the following template:
\n\n---\ntitle: Hello, World!\nlayout: default\n---\n\nWelcome to the website!\nAny value in the front matter is stored in the page state. This state can be accessed using:
\n\n{% raw %}{{ page.title }}{% endraw %}\n
\n\nTip
\nYou can access the name of the template from which a page was generated with:
\n\n{% raw %}{{ page.generated_from }}{% endraw %}This is useful if you want to make a public edit page to a GitHub repository, like the one in the footer of this documentation.
\nPost State
\n\nPost state stores information about a blog post.
\n\nYou can access post state on any template that is used by a post.
\n\nFor example, consider the following template called pages/_layouts/post.html for rendering a blog post:
\n\n---\nlayout: default\n---\n\n<h1>{% raw %}{{ post.title }}{% endraw %}</h1>\n\n<p>{% raw %}{{ post.content }}{% endraw %}</p>\nHere, we access the title and content of the post using the post state.
\n\nThis template (pages/_layouts/post.html) inherits from the default layout, and could be used on any blog post with:
\n\n---\nlayout: post\ntitle: Hello, World!\n---\n\n...\nSite State
\n\nPage state stores values that are global to the website.
\n\nYou can access site state on any page.
\n\nBy default, site state contains:
\n\n- \n
- A list of your posts (
site.posts) \n - The root URL of your site (
site.root_url) \n - The build date of your site (
site.build_date) \n - A list of all pages in your site (
site.pages) \n
For example, consider the following template:
\n\n---\ntitle: Blog Home\nlayout: default\n---\n\n{% raw %}\n<ul>\n {% for post in site.posts[:5] %}\n <li>\n <a href="{{ post.url }}">{{ post.title }}</a>\n </li>\n {% endfor %}\n</ul>\n{% endraw %}\nHere, we iterate over the first five posts in the site state and display them on the page.
\n\nThe above code could be used on a home page to display the most recent posts.
\n\nYou can add custom values to your site state by adding to the SITE_STATE dictionary in your config.py file:
\n\nSITE_STATE = {\n 'site_version': os.getenv('SITE_VERSION', '1.0.0')\n}\nWhen you create a new Aurora site, some folders and files are created by default.
\n\nBelow is a list of those files.
\n\n\nโโโ _site # where your generated site is stored\nโย ย โโโ index.html\nโโโ assets # where to store your CSS, JS, and images\nโโโ config.py # your Aurora configuration\nโโโ pages # any page in this directory is generated\n โโโ _data # store JSON / CSV files to be used in generating pages\n โโโ _layouts # page layouts\n โโโ posts # blog posts\n โโโ templates # store single pages to generate\n โโโ index.html\nSee Also
\n\n- \n
- Site configuration \n
- \n
- \n
![](\"https://github.com/capjamesg/aurora-blog-template/raw/main/blog.png\")
\n Blog\n \n - \n
![](\"https://github.com/capjamesg/aurora-docs-template/raw/main/screenshot.png\")
\n Documentation\n \n\n"
},
{
"path": "docs/pages/templates/templating.md",
"content": "---\ntitle: Templating with Jinja2\nlayout: default\npermalink: /templating/\n---\n\nAurora supports using [jinja2](https://jinja.palletsprojects.com/en/3.1.x/) to create template logic.\n\njinja2 is a popular Python templating engine with support for variable interpolation, conditionals, loops, and more.\n\nYou can use jinja2 in any HTML or markdown document in your Aurora project.\n\nHere is an example of a Jinja2 template that defines a blog home page:\n\n```html\n---\ntitle: Blog\nlayout: default\npermalink: /blog/\n---\n\n - \n
\n James' Coffee Blog\n (1,500+ pages)\n
\n - \n
- \n
- \n
- \n The Great Gatsby - F. SCOTT FITZGERALD \n \n\n
- \n Hello, World!\n \n\n
- \n Study Hall\n \n \n
- \n Quiet Corner\n \n \n
- \n Hello, World!\n \n \n
- \n Hello, World!\n \n \n
- \n Hello, World!\n \n \n
- \n Hello, World!\n \n \n
- \n {{ post.title }}\n \n {% endfor %}\n
- \n {{ post.title }}\n \n {% endfor %}\n
- \n {{ room.title }}\n \n {% endfor %}\n
- \n {{ post.title }}\n \n {% endfor %}\n
- \n {{ book.title }} - {{ book.author | capitalize }} \n \n {% endfor %}\n
Blog
\n\n{% for post in site.posts %}\n{{ post.title }}
\n{{ post.content }}
\n{% endfor %}\n```\n" }, { "path": "docs/pages/templates/users.html", "content": "---\ntitle: Users\nlayout: default\n---\n\nThe following sites are built with Aurora:
\n\n- \n
\n If you would like your site to be featured here, please submit a pull request to the\n Aurora GitHub repository.\n
\n" }, { "path": "docs/state.json", "content": "{\"last_build\": \"2024-06-22T19:51:46.751675\", \"data_file_integrity\": {\"pages/test/apple/index.html\": \"542b47f9fbb9dca05694183f48c8fe925e193b45\", \"pages/test/banana/index.html\": \"f49e2e069c37a6fc12809ba2db409db23cccfba9\", \"apple\": \"542b47f9fbb9dca05694183f48c8fe925e193b45\", \"banana\": \"f49e2e069c37a6fc12809ba2db409db23cccfba9\"}}" }, { "path": "requirements.txt", "content": "jinja2\nlivereload\ntoposort\npyromark~=0.9.3\npython-frontmatter\nrequests\nprogress\nclick\norjson\ntqdm\nchardet\nbs4\n" }, { "path": "setup.py", "content": "import re\n\nimport setuptools\nfrom setuptools import find_packages\n\nwith open(\"./aurora/__init__.py\", \"r\") as f:\n content = f.read()\n # from https://www.py4u.net/discuss/139845\n version = re.search(r'__version__\\s*=\\s*[\\'\"]([^\\'\"]*)[\\'\"]', content).group(1)\n\nwith open(\"README.md\", \"r\", encoding=\"UTF-8\") as fh:\n long_description = fh.read()\n\nsetuptools.setup(\n name=\"aurora-ssg\",\n version=version,\n author=\"capjamesg\",\n author_email=\"readers@jamesg.blog\",\n description=\"A fast static site generator implemented in Python.\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n url=\"https://github.com/capjamesg/aurora\",\n install_requires=[\n \"jinja2\",\n \"livereload\",\n \"toposort\",\n \"pyromark>=0.6,<0.10\",\n \"python-frontmatter\",\n \"requests\",\n \"progress\",\n \"click\",\n \"orjson\",\n \"tqdm\",\n \"python-dateutil\",\n \"chardet\",\n \"bs4\"\n ],\n include_package_data=True,\n package_data={\"\": [\"templates/index.html\"]},\n packages=find_packages(exclude=(\"tests\",)),\n entry_points={\n \"console_scripts\": [\n \"aurora = aurora.cli:main\",\n ],\n },\n extras_require={\n \"dev\": [\n \"flake8\",\n \"black==25.11.0\",\n \"isort\",\n \"twine\",\n \"pytest\",\n \"wheel\",\n \"mkdocs-material\",\n \"mkdocs\",\n ],\n },\n classifiers=[\n \"Programming Language :: Python :: 3\",\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: OS Independent\",\n ],\n python_requires=\">=3.7\",\n)\n" }, { "path": "tests/fixtures/about.html", "content": "\n\n \n \n \nWe serve 100 readers every month.
\n \n\n" }, { "path": "tests/fixtures/about_ISO-8859-1.html", "content": "\n\n \n \n \nA test of a file encoded with ISO-8859-1.
\n\nWe serve 100 readers every month.
\n \n" }, { "path": "tests/fixtures/about_UTF-16-BE.html", "content": "\n\n \n \n \nA test of a file encoded with UTF-16 BE.
\n\nWe serve 100 readers every month.
\n \n" }, { "path": "tests/fixtures/about_Windows-1252.html", "content": "\n\n \n \n \nA test of a file encoded with Windows-1252\t.
\n\nWe serve 100 readers every month.
\n \n" }, { "path": "tests/fixtures/book.html", "content": "\n\n \n \n \nThe Great Gatsby
\nF. Scott Fitzgerald
\n \n\n" }, { "path": "tests/fixtures/book_list.html", "content": "\n\n \n \n \nBooks
\n\n- \n\n
- \n\n
- \n \n
Posts from 2024
\n\nBelow are the posts we wrote in 2024.
\n\n\n\n\n\n\n- \n \n
Posts from 2024/01
\n\nBelow are the posts we wrote in 2024/01.
\n\n\n\n\n- \n \n
Posts from January 01, 2024
\n\nBelow are the posts we wrote on January 01, 2024.
\n\n\n- \n \n
Welcome to the library!
\n \n \n\n" }, { "path": "tests/fixtures/new_site_config.py", "content": "import os\n\nBASE_URLS = {\n \"local\": os.getcwd(),\n \"production\": \"https://example.com\",\n}\n\nSITE_ENV = os.environ.get(\"SITE_ENV\", \"local\")\nBASE_URL = BASE_URLS[SITE_ENV]\nROOT_DIR = \"pages\"\nLAYOUTS_BASE_DIR = \"_layouts\"\nSITE_DIR = \"_site\"\nHOOKS = {}\nSITE_STATE = {}\n" }, { "path": "tests/fixtures/post.html", "content": "\n\n \n \n \nThis is our first blog post.
\n\n \n\n" }, { "path": "tests/fixtures/review.html", "content": "\n\n \n \n \nJames
\n\nAn excellent book.
\n\n5/5 stars
\n \n\n" }, { "path": "tests/fixtures/robots.txt", "content": "User-Agent: *\nAllow: /\n" }, { "path": "tests/fixtures/styles.css", "content": "* {\n font-family: San system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;\n}\n" }, { "path": "tests/fixtures/tag_archive.html", "content": "\n\n \n \n \n- \n \n
{{ page.title }}
\n{{ page.author }}
\n" }, { "path": "tests/library/pages/_layouts/category.html", "content": "---\nlayout: default\ntitle: \"Category Archive\"\n---\n\n- \n {% for post in page.posts %}\n
Posts from {{ page.date | year }}
\n\nBelow are the posts we wrote in {{ page.date | year }}.
\n{% endif %}\n\n{% if page.date_type == \"month\" %}\nPosts from {{ page.date | archive_date }}
\n\nBelow are the posts we wrote in {{ page.date | archive_date }}.
\n{% endif %}\n\n{% if page.date_type == \"day\" %}\nPosts from {{ page.date | long_date }}
\n\nBelow are the posts we wrote on {{ page.date | long_date }}.
\n{% endif %}\n\n- \n {% for post in page.posts %}\n
{{ page.name }}
\n\n{{ page.review }}
\n\n{{ page.star }}/5 stars
\n" }, { "path": "tests/library/pages/_layouts/rooms.html", "content": "---\nlayout: default\ntitle: Rooms\n---\n\n- \n {% for room in page.current_page %}\n
- \n {% for post in page.posts %}\n
Quiet Corner
" }, { "path": "tests/library/pages/rooms/study-hall.html", "content": "---\ntitle: Study Hall\nlayout: default\ncollection: rooms\n---\n\nStudy Hall
" }, { "path": "tests/library/pages/templates/about.html", "content": "---\ntitle: About\nlayout: default\n---\n\nWe serve {{ page.visitors }} readers every month.
\n" }, { "path": "tests/library/pages/templates/about_ISO-8859-1.html", "content": "---\ntitle: About ISO Test\nlayout: default\n---\n\nA test of a file encoded with ISO-8859-1.
\n\nWe serve {{ page.visitors }} readers every month.
\n" }, { "path": "tests/library/pages/templates/about_Windows-1252.html", "content": "---\ntitle: About Windows-1252 Test\nlayout: default\n---\n\nA test of a file encoded with Windows-1252\t.
\n\nWe serve {{ page.visitors }} readers every month.
\n" }, { "path": "tests/library/pages/templates/book_list.html", "content": "---\ntitle: Book List\npermalink: /book-list/\nlayout: default\n---\n\nBooks
\n\n- \n {% for book in site.books %}\n