README.md

An intuitive UI for managing data, for users of all technical skill levels. Built on Postgres.

Mathesar code • Website • Docs • Matrix (chat) • Wiki

Mathesar website

This repository is a Jekyll website that powers https://mathesar.org. It is hosted on GitHub Pages.

Table of Contents

• Local setup
  • Installation
  • Running locally
• Publishing to the Blog
  • Creating a new blog post
  • Creating Author Pages
  • Creating Tag Pages
  • Updating Author Pages

Local setup

Installation

1. Install Jekyll (ensure you also install bundler)
2. From repo root directory, run bundle install
3. From repo root directory, run npm install

Running locally

1. Run:

   bundle exec jekyll serve --port 4000 --livereload
   

2. Browse to http://localhost:4000/

Publishing to the Blog

To publish a new post on the Mathesar blog, follow these steps.

Creating a new blog post

1. Create a new Markdown file in the _posts directory. The file name should follow this format: YYYY-MM-DD-title-of-the-post.md.

2. Fill out the front matter for your post. At the beginning of your Markdown file, include the following:

   ---
   layout: post
   title:  "Title of Your Post"
   tags: tag1 tag2 tag3
   date: YYYY-MM-DD
   author: author_id
   description: "Brief description of the post."
   image: /path/to/featured/image.jpg
   ---

3. Write your blog post. After the front matter, use regular Markdown syntax to write your post.

Creating Author Pages

If author_id does not exist in _data/authors.yml:

1. Add author details to _data/authors.yml. If your author ID does not exist, create a new entry with your details.

   your_author_id:
     name: Author Name
     role: Author Role
     bio: >
       "A brief bio about the author. This can be a few sentences long."
     image: /path/to/your/image.jpg

Creating Tag Pages

If you've added new tags:

1. Run the tag generator script. From the root directory, execute:

   python scripts/tag_generator.py
   

This will generate pages for the new tags.

Updating Author Pages

If you've added yourself as a new author:

1. Run the author generator script. From the root directory, execute:

   python scripts/author_generator.py
   

This will generate a page for your author profile.

Remember to run the above scripts if you're introducing new tags or authors to ensure the website accurately reflects these changes.