add venv info and blog manpage

This commit is contained in:
Hugh Rundle 2024-09-21 07:55:05 +10:00
parent d07af639e0
commit 9417e4e921
Signed by: hugh
GPG key ID: A7E35779918253F9
4 changed files with 162 additions and 14 deletions

72
blog.1 Normal file
View file

@ -0,0 +1,72 @@
.\" Automatically generated by Pandoc 3.1.5
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "Blog" "1" "" "Version 1.0" "Tips for the blog command and using Zola"
.hy
.SH NAME
.PP
\f[B]blog\f[R] - helper command for zola.
.SH DESCRIPTION
.PP
Here are some tips for Hugh\[cq]s custom Zola set up.
.SH EXAMPLES
.TP
\f[B]aside\f[R]
appears on the righthand side in desktop or underneath in mobile view
.IP
.nf
\f[C]
{% aside() %}
Hello there!
This is [a link](https://hugh.run)
{% end %}
\f[R]
.fi
.TP
\f[B]quote\f[R]
block quote - fills the entire screen
.IP
.nf
\f[C]
{% quote(author=\[dq]Hugh Rundle\[dq], title=\[dq]Shit Hugh said\[dq], url=\[dq]https://hugh.run\[dq]) %}
Zola is a pretty cool rendering engine, I must admit.
{% end %}
\f[R]
.fi
.TP
\f[B]link\f[R]
For the \f[I]/links\f[R] section - this combines a comment with a quote
.IP
.nf
\f[C]
{{ link(
url=\[dq]https://aeon.co/essays/we-should-take-awkwardness-less-personally-and-more-seriously\[dq],
title=\[dq]Here is the title of the article\[dq],
quote=\[dq]Awkwardness highlights the fact that our interactions are scripted.\[dq]
)
}}
\f[R]
.fi
.SH SEE ALSO
.PP
cheatsheet(7)
.SH AUTHORS
Hugh Rundle.

58
blog.1.md Normal file
View file

@ -0,0 +1,58 @@
% Blog(1) Version 1.0 | Tips for the blog command and using Zola
% Hugh Rundle
NAME
====
**blog** - helper command for zola.
DESCRIPTION
===========
Here are some tips for Hugh's custom Zola set up.
EXAMPLES
========
**aside**
: appears on the righthand side in desktop or underneath in mobile view
```
{% aside() %}
Hello there!
This is [a link](https://hugh.run)
{% end %}
```
**quote**
: block quote - fills the entire screen
```
{% quote(author="Hugh Rundle", title="Shit Hugh said", url="https://hugh.run") %}
Zola is a pretty cool rendering engine, I must admit.
{% end %}
```
**link**
: For the _/links_ section - this combines a comment with a quote
```
{{ link(
url="https://aeon.co/essays/we-should-take-awkwardness-less-personally-and-more-seriously",
title="Here is the title of the article",
quote="Awkwardness highlights the fact that our interactions are scripted."
)
}}
```
SEE ALSO
====
cheatsheet(7)

View file

@ -19,16 +19,6 @@
.SH NAME .SH NAME
.PP .PP
\f[B]cheatsheet\f[R] - tips and reminders for Hugh. \f[B]cheatsheet\f[R] - tips and reminders for Hugh.
.SH SYNOPSIS
.PP
\f[B]man cheatsheet\f[R]
.IP
.nf
\f[C]
pandoc --standalone -t man cheatsheet.7.md -o cheatsheet.7
ln -s /User/hugh/coding/man/chatesheet.7 /usr/local/share/man/man7/
\f[R]
.fi
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This is a man page to remind Hugh of some basic commands and techniques This is a man page to remind Hugh of some basic commands and techniques
@ -61,6 +51,13 @@ Where \f[I]remote\f[R] is the remote name you want to fetch from,
\f[I]id\f[R] is the PR id, and \f[I]branchname\f[R] is the name you want \f[I]id\f[R] is the PR id, and \f[I]branchname\f[R] is the name you want
to give to the new LOCAL branch you will create with this command. to give to the new LOCAL branch you will create with this command.
e.g.\ \f[I]fetch bookwyrm pull/999/head:testing\f[R] e.g.\ \f[I]fetch bookwyrm pull/999/head:testing\f[R]
.TP
\f[V]git push git\[at]github.com:remoteUser/remoteRepo localBranch:remoteBranch\f[R]
Push a change to someone else\[cq]s pull request.
Where \f[I]localBranch\f[R] is the branch name in your local repository,
and \f[I]remoteBranch\f[R] is \f[B]their\f[R] branch name.
More info at
https://codinhood.com/micro/add-commits-persons-pr-on-your-repo/
.PP .PP
\f[B]python\f[R] \f[B]python\f[R]
.TP .TP
@ -68,8 +65,21 @@ e.g.\ \f[I]fetch bookwyrm pull/999/head:testing\f[R]
Spins up a web server with file root wherever you called this from, on Spins up a web server with file root wherever you called this from, on
\f[I]port\f[R] \f[I]port\f[R]
.TP .TP
\f[V]venv\f[R] \f[V]python -m venv /path/to/new/virtual/environment\f[R]
TODO Create a virtual environment.
For example:
.RS
.PP
\f[V]python -m venv venv\f[R] - creates a directory \f[V]venv\f[R].
.PD 0
.P
.PD
To activate: \f[V]source <venv>/bin/activate\f[R]
.PD 0
.P
.PD
To deactivate: \f[V]deactivate\f[R]
.RE
.PP .PP
\f[B]Docker\f[R] \f[B]Docker\f[R]
.TP .TP

View file

@ -44,15 +44,23 @@ EXAMPLES
: Where *remote* is the remote name you want to fetch from, *id* is the PR id, and *branchname* is the name you want to give to the new LOCAL branch you will create with this command. e.g. *fetch bookwyrm pull/999/head:testing* : Where *remote* is the remote name you want to fetch from, *id* is the PR id, and *branchname* is the name you want to give to the new LOCAL branch you will create with this command. e.g. *fetch bookwyrm pull/999/head:testing*
`git push git@github.com:remoteUser/remoteRepo localBranch:remoteBranch`
: Push a change to someone else's pull request. Where *localBranch* is the branch name in your local repository, and *remoteBranch* is **their** branch name. More info at https://codinhood.com/micro/add-commits-persons-pr-on-your-repo/
**python** **python**
`python -m http.server [port]` `python -m http.server [port]`
: Spins up a web server with file root wherever you called this from, on *port* : Spins up a web server with file root wherever you called this from, on *port*
`venv` `python -m venv /path/to/new/virtual/environment`
: TODO : Create a virtual environment. For example:
`python -m venv venv` - creates a directory `venv`.
To activate: `source <venv>/bin/activate`
To deactivate: `deactivate`
**Docker** **Docker**