From e724c784193d9f4d3395a1756943599b3e0cfaea Mon Sep 17 00:00:00 2001 From: despiegk <> Date: Wed, 7 Dec 2022 16:25:43 +0300 Subject: [PATCH] small mod for config file, so is a template --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b654a21..ef2773b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ -# OURWORLD NOMAD Website +# OUR PARADOSE Website wesite on https://nomads.ourworld.tf/ -## About +> More info see (gdoc)[https://docs.google.com/document/d/1RuWIVcuhSE5BGF1HkgXqKVOcF31g0CQR-EjhcAAlHoA/edit#] + +## Developers A website created using Zola, a static site generator. - The contents of the pages reside in the markdown files in /content (written in CommmonMark) - The pages are rendered using HTML templates with Tailwind CSS framework in /templates -## Getting Started +### Getting Started This repository is meant to use as a template for static sites. @@ -21,9 +23,9 @@ To use this repository as a template, simply: - run `npm install` to install dependencies - run `npm run start` -## How to create pages using this template +### How to create pages using this template -### Structure of the content directory +#### Structure of the content directory Every index.md file in a content directory corresponds to a page, and the landing page is content/\_index.md. The path of each page is simply its path relavant to the root of the content directory. @@ -33,9 +35,9 @@ content/\_index.md -> yoururl.com/ content/blog/\_index.md -> yoururl.com/blog content/careers/index.md or content/careers.md -> yoururl.com/careers -### Section Templates +#### Section Templates -#### Blog.html +##### Blog.html The blog page is created by default if there is a blog folder in the content directory. The blog page consists of a featured post row, a paginated grid of posts sorted by recency, and a side nav of post categories and featured posts. @@ -43,11 +45,11 @@ Blog posts can have categories, and can be filtered by said categries. To add a To make a blog post featured, simply add an isFeatured attribute to the yaml header of the blog post. The most recent featured blog post wiil be displayed on the heading row of the blog page, and the rest will be displayed under featured posts in the side nav. See /content/blog/2019/03/post-5/index.md for implementation. -#### Section.html +##### Section.html The default section template, displays section body without styling (except for margins), and displays subpages of the section below. The subpages of the page are displayed as small summaries of pages with title, description, and categories, as rendered by partials/pageBox.html. The subpages are grouped by the taxonomy name passed in as the "group_pages_by" extra attribute, defined in the section's yaml header. -### Creating custom pages +#### Creating custom pages To create your own page, simply create a markdwn file following the examples provided above. By default, the markdown file will be displayed plainly as it is. @@ -56,7 +58,7 @@ By default, the markdown file will be displayed plainly as it is. If you wish to display your markdown files in a specific page template, simply define the template you would like to use in the yaml header of your markdown file. For instance, the blogPage.html template displays blog posts with author info, date, side margins, and a hero image on top of the post. See any blog page in /content for implementation. -### Shortcodes +#### Shortcodes To give website creators freedom in styling without necessitating getting outside of the /content directory and in to the html files, the template has a few features. @@ -94,13 +96,13 @@ Simple annotation shorcode that can be used to create annotation objects in mark You can size your markdown images by adding #small, #medium or #large at the end of the images source url. See /content/\_index.md for implementation. -### Header & Footer +#### Header & Footer The header and footer are also created from markdown files in the content directory. In /content/header/\_index.md, each header item is bulleted. If a header item has a row beneath it, the row will be displayed as a sub-menu on click. Otherwise, if header item is a link, it will simply navigate to the linked page. The footer, likewise, is structured using the row shortcode. However the left section with page summary is built in. To edit the site destcription, one should edit the description (in the yaml header) of the footer md file. To edit the social links, simply add the social outlets name and your link into the socialLinks dictionary attribute on the yaml header of the footer/\_index.md. If a social icon exists for the social outlet, the link wiill be automatically rendered within the icon, displayed in the footer. -## Resources & References +### Resources & References This project was started using a [Zola Tailwind starter set](https://github.com/brycewray/zola_twcss) Some templates were created using [Tailwind UI](https://tailwindui.com)