Skip to content

Forking this garden

Follow the next steps.

Download the repository

On your terminal, clone this repository with:

git clone https://github.com/lyz-code/blue-book.git

Don't fork the repository via Github

If you do that, you'll have all the history of my repository, which will make your repository more heavy than it should (as I have a lot of images), and it will make it hard for me to make pull requests to your digital garden.

Adaptations

Project name and repository URL

There are several files that contain references to this repository's name and URL, which is different to the new forked repository URL, since the user name and the repository name might have changed. As of now, the files where you should replace the references are:

  • README.md
  • mkdocs.yml
  • theme/main.html

Blue book is the name of my personal digital garden, try to find a different name for your project that is meaningful to you.

Documents and structure

You can either use the documents of this wiki and extend them, or change the structure by editing the nav section of the mkdocs.yml file. If you want to start from scratch, remove everything on the docs directory.

Remove the newsletter feature

The newsletter feature allows your readers to keep updated on the changes of your garden. If you don't want them:

  • Remove the plugin mkdocs-newsletter from the requirements.in and mkdocs.yaml files.
  • Remove the references both to header and footer. To do that, undo the steps described here.
  • Remove the cron configuration of the .github/workflows/gh-pages.yml pipeline:

    schedule:
        - cron: 11 06 * * *
    

Dependencies

In order to be able to build your site, some Python dependencies are needed. You can install them by running

make update

Checking how it looks

First, clean the old generated site with

make clean

Then, you can preview the site on your local machine by running

make

and then opening the link in your web browser.

Set up the Github repository

On GitHub create a new repository by clicking on the + symbol on the top right and then New Repository.

Removing the old commits

The mkdocs-newsletter plugin uses the commit history to generate the newsletter articles, so if you want to start the newsletter from scratch, a way of doing so is removing the commit history.

A way of doing so is removing the .git folder and re-initializing the repository. Within the repository directory do

rm -rf .git
git init
git remote add origin git@github.com:your_username/your_project_name.git
git add .
git commit -m "Initial commit"
git push --set-upstream origin master

Remember to change your_username and your_project_name to your real values.

Setting up GitHub Pages

To enable the Github Pages website associated with your repo, follow these steps:

Now, the site will be built whenever you push new commits and periodically, according to the cron configuration from .github/workflows/gh-pages.yml.


Last update: 2021-05-25