DEV Community: SMJ

Build site with Franklin.jl

SMJ — Tue, 01 Dec 2020 03:08:21 +0000

Forward

Franklin.jl is a simple, customisable static site generator oriented towards technical blogging and light, fast-loading pages.

At first, I want to learning Julia with a small open source project, smaller and better. Then I search on github with topic#julia, and I find this tool. As I learned about it on its site, I think I can use this for my massively personal site(maybe it is beautiful, but too complex), and learning Julia when rebuilding my site.

Therefore, I write this tutorial as my beginning.

Last but not least, Franklin.jl has many features:

Augmented markdown allowing definition of LaTeX-like commands,
Easy inclusion of user-defined div-blocks,
Maths rendered via KaTeX, code via highlight.js both can be pre-rendered,
Can live-evaluate Julia code blocks,
Live preview of modifications,
Simple optimisation step to compress and pre-render the website,
Simple publication step to deploy the website,
Straightforward integration with Literate.jl.

Setup Environment

Download Julia from official site for your OS.
Install it.
Open julia REPL.
Then excute using Pkg; Pkg.add(Franklin)

Start building

New a site with the following scripts:

julia> using Franklin
julia> newsite("mySite", template="pure-sm")
✓ Website folder generated at "mySite" (now the current directory).
→ Use serve() from Franklin to see the website in your browser.

Once you excuted the command above, this Julia REPL workspace will be in your site folder.

Start local server for debug:

julia> serve()
→ Initial full pass...
→ Starting the server...
✓ LiveServer listening on http://localhost:8000/ ...
  (use CTRL+C to shut down)

you can get this page in your browser:

note: this mySite folder will be created in your current directory. You can check your current directory withpwd().

Site Structure

Page structure

your mySite folder structure like this:

├─.github
│  └─workflows
├─_assets
│  └─scripts
│      └─output
├─_css
├─_layout
├─_libs
│  ├─highlight
│  ├─katex
│  │  └─fonts
│  └─pure
└─__site
    ├─assets
    │  ├─menu1
    │  │  ├─code
    │  │  │  └─output
    │  │  └─output
    │  └─scripts
    │      └─output
    ├─css
    ├─layout
    ├─libs
    │  ├─highlight
    │  ├─katex
    │  │  └─fonts
    │  └─pure
    ├─menu1
    ├─menu2
    ├─menu3
    └─tag
        ├─code
        ├─image
        └─syntax

The .github folder is generated for Github Actions, you can config some fields for your customization.Fox example, you can change trigger branch from dev to your workspace branch like master.

name: Build and Deploy
on:
  push:
    branches:
-      - dev
+      - master

Then you should change another BRANCH(I named it as site branch) field here:

    - name: Build and Deploy
      uses: JamesIves/github-pages-deploy-action@releases/v3
      with:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-       BRANCH: master
+       BRANCH: dev
        FOLDER: __site

NOTE: you must keep the site branch different from the workspace branch(in the case it's master), because you site files will be generated on dev branch

If you use config above, your master branch is your workspace branch and your dev branch is your Github Pages site branch.

Deploying on GitHub

local config

Create a personal repo on github, named username.github.io, or you can name it whatever you want to if you have a domain.
Open local folder you created with Franklin before with bash or any other shell.
Follow these steps below to config your repo:
i)git remote add origin URL_TO_YOUR_REPO
ii)git add . && git commit -m "initial files"
iii)git push -u origin master

github config

Open Settings on your repo page, and scrolling down until you find GitHub Pages option.
Config it as below:

note: you must make the branch same as the site branch in the deploy.yml

DONE!

You can find some examples of websites using Franklin.jl from Franklin.jl.

By the way, I following this blog site as templates and customizing it. It is a very simple and wonderful site.

Please comment or email me if there are any errors.

REFERENCE

https://franklinjl.org/

https://github.com/abhishalya/abhishalya.github.io

https://docs.github.com/

How to speed up GIT PUSH

SMJ — Wed, 16 Oct 2019 09:02:51 +0000

OS: Windows10
Shell: git bash
Platform: GitHub
Protocol: ssh

Can anyone help me with Git Push Speed? I have 7 MB/S connection but push and pull are at 90-110 KB/S. It take hours to push and I got this error:

fatal: remote end hung up unexpectedly

Thanks in advance.

I can't use any firefox add-ons

SMJ — Sat, 04 May 2019 08:22:57 +0000

All my firefox add-ons are reported some bugs, and I also can't install other add-ons.

Why?

Arch Linux Installation Guide on HP Pavilion

SMJ — Thu, 02 May 2019 09:59:34 +0000

My computer details:

Computer: HP Pavilion laptop
CPU: Intel i5-8250U
GPU: NVIDIA MX150

Pre-installation

Verify the boot mode

To verify if it is UEFI mode, use this command:
ls /sys/firmware/efi/efivars
If it show some details, the system is UEFI. Otherwise, the system may be booted in BIOS or CSM mode.

Connect to the internet

Because I'm using HP laptop. so i just need connect to wifi with this command wifi-menu. If you want to connect to wired network, reference official guide about dhcpcd
You can check this connection by ping www.archlinux.org.

Update the system clock

Use timedatectl set-ntp true to ensure the system clock is accurate, to check the service status, use timedatectl status.

Partition the disks

Use lsblk or fdisk -l to vertified device.
First, run fdisk /dev/sda（note: if your device is /dev/sdX, run fdisk /dev/sdX), and you will enter the fdisk dialog.
Next enter m you will get help details. If you use a separate hard drive. enter g to format it as GPT.
Next, enter n to create new partitions, enter w to exit if you finished.

This is my partition layout:

Mount points	Partition	Partition Type	Size
/mnt	/dev/sda3	linux filesystem	50G
/mnt/boot	/dev/sda2	linux filesystem	500M
/mnt/boot/EFI	/dev/sda1	EFI system partition	500M
[swap]	/dev/sda4	linux swap	16G
/mnt/home	/dev/sda5	linux filesystem	300G

Format the partitions

If the EFI partition is on /dev/sdX0, run:
mkfs.fat -F32 /dev/sdX0

If the root partition is on* /dev/sdX1* and will contain the ext4 file system, run:
mkfs.ext4 /dev/sdX1

If you created a partition for swap, initialize it with mkswap:

mkswap /dev/sdX2
swapon /dev/sdaX2

Run these commands if you use my layout:

mkfs.fat -F32 /dev/sda1
mkfs.ext4 /dev/sda2
mkfs.ext4 /dev/sda3
mkfs.ext4 /dev/sda5
mkswap /dev/sda4
swapon /dev/sda4

Mount the file systems

Run these commands if you use my layout:

mount /dev/sda3 /mnt
mkdir /mnt/boot
mount /dev/sda2 /mnt/boot
mkdir /mnt/boot/EFI
mount /dev/sda1 /mnt/EFI
mkdir /mnt/home
mount /dev/sda5 /mnt/home

Installation

Select mirrors

Open mirrorlist file by nano /etc/pacman.d/mirrorlist
Uncomment your selected server.
save changes ### Install the base packages Use pacstrap /mnt base base-devel ## Configure the system ### Generate an fstab file
Use genfstab -U /mnt >> /mnt/etc/fstab
Check it in case of errors: cat /mnt/etc/fstab ### Into new system Run arch-chroot /mnt ### Timezone and Location
Set Timezone:
ln -sf /usr/share/zoneinfo/Region/City /etc/localtime
Set the hardware clock:
hwclock --systohc
Set location
Uncomment en_US.UTF-8 UTF-8 and other needed locales in /etc/locale.gen, and generate it:

nano /etc/locale.gen 
locale-gen

By the way, the new system doesn't have vim.

Create the locale.conf and set LANGvariable:

nano /etc/locale.conf
LANG= en_US.UTF-8 UTF-8

Network Config

Create the hostname file and enter your hostname: nano /etc/hostname.
Add matching entries to hosts:

127.0.0.1   localhost
::1     localhost
127.0.1.1   myhostname.localdomain  myhostname

Set root password

Run passwd

Enable microcode updates

pacman -S intel-ucode # for intel CPU
pacman -S amd-ucode # for amd CPU

Install and set Bootloader

I use grub, so:

Install related packages: pacman -S grub dosfstools efibootmgr
Install grub grub-install --target=x86_64-efi --efi-directory=/boot/EFI --recheck
Use the grub-mkconfig tool to generate /boot/grub/grub.cfg: grub-mkconfig -o /boot/grub/grub.cfg

Install Wireless LAN tools

I use wifi-menu to connect to wifi, so I need this packages:
pacman -S wpa_supplicant dialog iw

Add a user

Add a user useradd -m -g users -s /bin/bash username
Set password for user passwd username
Privilege escalation(sudo) nano /etc/sudoers and add username ALL=(ALL) ALL below root ALL=(ALL) ALL

Post-Installation

Install display server

Run the minimal command: pacman -S xorg-server.

Install display driver

Because I use*NVIDIA MX150* graphics card, I use this xf86-video-nouveaudriver. For details you can referrence this. If you use amd card, you can read this

Thank you for reading!
I will continue to update this article later if I find something.

Can I change the linux kenrnel to a lower version on docker?

SMJ — Sun, 10 Mar 2019 04:31:26 +0000

I want to compile and run a linux-2.x kernel without a VM, but a linux container.

Ubuntu 18.04 install Java and Eclipse IDE

SMJ — Fri, 08 Mar 2019 09:58:28 +0000

Requirements

Download an JDK gz file.
https://www.oracle.com/technetwork/java/javase/downloads/index.html
Download Eclipse IDE installer gz file.
https://www.eclipse.org/downloads/download.php?file=/oomph/epp/2018-12/R/eclipse-inst-linux64.tar.gz
you can select an mirror site for downloading it.

Config JDK

Extract and Install Java

tar -xvf ~/Downloads/jdk1.8.0_201.tar.gz

Create an folder to store it.

sudo mkdir /usr/lib/jvm/jdk1.8.0_201

Move extracted package to the directory.

sudo mv jdk1.8.0_201*/* /usr/lib/jvm/jdk1.8.0_201/

Run the commands below to configure java.

sudo update-alternatives --install "/usr/bin/java" "java" "/usr/lib/jvm/jdk1.8.0_201//bin/java" 1010 
sudo update-alternatives --install "/usr/bin/javac" "javac" "/usr/lib/jvm/jdk1.8.0_201//bin/javac" 1010 
sudo update-alternatives --install "/usr/bin/javaws" "javaws" "/usr/lib/jvm/jdk1.8.0_201//bin/javaws" 1010

Create `Java Environment Variables`.

New an file.
sudo vim /etc/profile.d/javajdk.sh

Copy this lines to javajdk.sh

export J2SDKDIR=/usr/lib/jvm/jdk1.8.0_201
export J2REDIR=/usr/lib/jvm/jdk1.8.0_201/jre
export PATH=$PATH:/usr/lib/jvm/jdk1.8.0_201/bin:/usr/lib/jvm/jdk1.8.0_201/db/bin:/usr/lib/jvm/jdk1.8.0_201/jre/bin
export JAVA_HOME=/usr/lib/jvm/jdk1.8.0_201
export DERBY_HOME=/usr/lib/jvm/jdk1.8.0_201/db

Make it effective.
source /etc/profile.d/javajdk.sh

Test if successful.
Run the commandjava -version, it will show messages like this

java version "1.8.0_201"
Java(TM) SE Runtime Environment (build 1.8.0_201-b09)
Java HotSpot(TM) 64-Bit Server VM (build 25.201-b09, mixed mode)

if it, Congratulations!

Install Eclipse

Extract eclipse installer gz file, then just run the eclipse-inst executable file.
or run the command on eclipse installer directiry
./eclipse-inst.

Next, it is some easy steps!

Add an icon on application lancher

Step1: change current directiry to `/usr/share/applicaitons`

cd /usr/share/applicaitons

Step2: new a `Java.desktop` file.

Input the lines:

[Desktop Entry]
Encoding=UTF-8
Name=Java #name it
Comment=Eclipse-Java
Exec=/path/eclipse #your path
Icon=/path/icon.xpm #your path
Terminal=false
StartupNotify=true
Type=Application
Categories=Application;Development;

Step3: Give it execution permission.

Run the command:
sudo chmod +x Java.desktop

Reference

https://websiteforstudents.com/install-oracle-java-jre-jdk-on-ubuntu-18-04-lts-beta/

This is my first post, if there are any errors, please correct me:)