=============== How to Develope

.. image:: https://img.shields.io/badge/Language-Python-blue.svg :target: https://www.python.org/

.. image:: https://img.shields.io/badge/Language-Go-blue.svg :target: https://golang.org/

.. .. image:: https://godoc.org/github.com/siongui/paligo?status.svg :target: https://godoc.org/github.com/siongui/paligo

.. image:: https://github.com/siongui/userpages/workflows/Pelican%20site%20CI/badge.svg :target: https://github.com/siongui/userpages/blob/master/.github/workflows/pelican.yml

.. .. image:: https://travis-ci.org/siongui/userpages.svg?branch=master :target: https://travis-ci.org/siongui/userpages

.. image:: https://gitlab.com/siongui/siongui.gitlab.io/badges/master/pipeline.svg :target: https://gitlab.com/siongui/siongui.gitlab.io/-/commits/master

.. .. image:: https://goreportcard.com/badge/github.com/siongui/paligo :target: https://goreportcard.com/report/github.com/siongui/paligo

.. image:: https://img.shields.io/badge/license-Unlicense-blue.svg :target: https://github.com/siongui/userpages/blob/master/UNLICENSE

.. See how to add travis ci image from https://raw.githubusercontent.com/demizer/go-rst/master/README.rst https://github.com/demizer/go-rst/commit/9651ab7b5acc997ea2751845af9f2d6efee825df

Development Tool: Pelican_ (static site generator written in Python)

Development Environment: Ubuntu 20.04_

First-time Setup

1. On a fresh/clean installation of Ubuntu, update system first. Otherwise will get unable to locate package error. See this SO answer <https://stackoverflow.com/a/58072486>__.

   .. code-block:: bash

   $ sudo apt-get update

2. Install git_ and pip_:

   .. code-block:: bash

   $ sudo apt-get install git $ sudo apt-get install python3-pip

   From the answer in Ask Ubuntu <https://askubuntu.com/a/1031733>_, we can use python-is-python3 and prevent Python 2 from being installed on Ubuntu 20.04

   .. code-block:: bash

   $ sudo apt-get install python-is-python3 $ sudo apt-mark hold python2 python2-minimal python2.7 python2.7-minimal libpython2-stdlib libpython2.7-minimal libpython2.7-stdlib

3. Install language packages to add locale (English, Traditional Chinese, and Thai):

   .. code-block:: bash

   $ sudo apt-get install language-pack-en $ sudo apt-get install language-pack-zh-hant $ sudo apt-get install language-pack-th

   Or you can install languages in "Settings" -> "Region & Language", which installs more related packages such as fonts for languages.

4. git clone source code:

   .. code-block:: bash

   $ cd $ mkdir dev $ cd ~/dev/ $ git clone https://github.com/siongui/userpages.git --depth=1

   or clone with full depth

   $ git clone https://github.com/siongui/userpages.git

5. Install Python tools:

   .. code-block:: bash

   $ cd ~/dev/userpages/ $ pip3 install -r requirements.txt

   Note that in .travis.yml <.travis.yml>_, pip is actually pip3 if bionic and python 3.8 is set in Travis CI config.

6. Install Pelican i18n_subsites_ plugin and download normalize.css_:

   .. code-block:: bash

   $ cd ~/dev/userpages/ $ make download

7. Generate CSS file:

   .. code-block:: bash

   $ cd ~/dev/userpages/ $ make scss

Daily Development

.. code-block:: bash

# start edit and develope
$ cd ~/dev/userpages/
# re-generate the website and start dev server
$ make
# open your browser and preview the website at http://localhost:8000/

Auto-deploy by GitHub Actions

See workflow file <.github/workflows/pelican.yml>_

Auto-deploy by Travis CI_ (Obsoleted)

See GitHub Pages Deployment - Travis CI_.

First save your personal access token_ in repository settings_.

For User Pages, the following is sample config:

.. code-block:: yaml

deploy: provider: pages repo: USERNAME/USERNAME.github.io target_branch: master skip_cleanup: true github_token: $GITHUB_TOKEN local_dir: output on: branch: master

For Project Pages, the following is sample config:

.. code-block:: yaml

deploy: provider: pages skip_cleanup: true github_token: $GITHUB_TOKEN local_dir: output on: branch: master

Deploy to GitLab Pages_ via GitLab CI/CD_

See .gitlab-ci.yml <.gitlab-ci.yml>_.

1. Use Ubuntu image in Docker Hub <https://hub.docker.com/_/ubuntu>_. The ubuntu:latest tag points to the "latest LTS".

2. Need to update Ubuntu first to install Ubuntu packages. See this SO answer <https://stackoverflow.com/a/58072486>__.

3. Travis CI_ can deploy to any repository, but need personal access token_ to do so. GitLab CI/CD_ can deploy to the repository where CI/CD runs without credentials.

UNLICENSE

All works, including posts and code, of Siong-Ui Te are released in public domain. Please see UNLICENSE_.

References

.. [1] pelican-edit-url <https://github.com/pmclanahan/pelican-edit-url>_ inspires the Edit on Github link.

.. [2] | JINJA_FILTERS in Settings — Pelican documentation <http://docs.getpelican.com/en/latest/settings.html>_ | Jinja custom filters documentation <http://jinja.pocoo.org/docs/dev/api/#custom-filters>_

.. [3] | Home Screen Icon on Android/iPhone & PWA support | website icon on android home screen - Google search <https://www.google.com/search?q=website+icon+on+android+home+screen>_ | Tutorial: Home Screen Icons | Responsive Web Design Training Tutorial | Webucator <https://www.webucator.com/tutorial/developing-mobile-websites/home-screen-icons.cfm>_ | pwa manifest - Google search <https://www.google.com/search?q=pwa+manifest>_ | WebPageTest - Website Performance and Optimization Test <https://www.webpagetest.org/>_

.. [4] | Add single page application support for Github pages · Issue #408 · isaacs/github · GitHub <https://github.com/isaacs/github/issues/408>_ | GitHub - rafgraph/spa-github-pages: Host single page apps with GitHub Pages <https://github.com/rafgraph/spa-github-pages>_ | S(GH)PA: The Single-Page App Hack For GitHub Pages — Smashing Magazine <https://www.smashingmagazine.com/2016/08/sghpa-single-page-app-hack-github-pages/>_ | GitHub - dmsnell/gh-pages-404-redirect: Can I use a custom 404 handler on GitHub pages to host a routed single-page app? <https://github.com/dmsnell/gh-pages-404-redirect>_ | Redirect a GitHub Pages site with this HTTP hack | Opensource.com <https://opensource.com/article/19/7/permanently-redirect-github-pages>_ | javascript - Is there a configuration in Github Pages that allows you to redirect everything to index.html for a Single Page App? - Stack Overflow <https://stackoverflow.com/questions/36296012/is-there-a-configuration-in-github-pages-that-allows-you-to-redirect-everything>_

.. [5] | github pages symbolic link - Google search <https://www.google.com/search?q=github+pages+symbolic+link>_ | Pages: allow symlinks · Issue #553 · isaacs/github · GitHub <https://github.com/isaacs/github/issues/553>_ | Added .nojekyll to workaround symlink issue in GitHub Pages. Ref: isaacs/github#553 · siongui/[email protected] · GitHub <https://github.com/siongui/paligo/commit/b9fe689770d705743a29bd33a3c7583a5c81bec1>_

.. _Pelican: https://blog.getpelican.com/ .. _Ubuntu 20.04: https://releases.ubuntu.com/20.04/ .. _git: https://git-scm.com/ .. _pip: https://pypi.python.org/pypi/pip .. _i18n_subsites: https://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites .. _normalize.css: https://necolas.github.io/normalize.css/ .. _Travis CI: https://travis-ci.org/ .. _GitHub Pages Deployment - Travis CI: https://docs.travis-ci.com/user/deployment/pages/ .. _personal access token: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token .. _repository settings: https://docs.travis-ci.com/user/environment-variables#defining-variables-in-repository-settings .. _GitLab Pages: https://docs.gitlab.com/ee/user/project/pages/ .. _GitLab CI/CD: https://docs.gitlab.com/ee/ci/ .. _Google Adsense: https://www.google.com/search?q=Google+AdSense .. _UNLICENSE: https://unlicense.org/