Commit `6f497dd65e`

6f497dd65e5d28bd5ac7939e92892c99a2a93eaf

parent: 351ff4ea5e

Unsigned

cmc <hello@cleberg.net> · 2025-05-08 23:03 UTC

update: README

Layout: unified · split

README.md deleted −86

		@@ -1,86 +0,0 @@
1		# cleberg.net
2
3		[cleberg.net](https://cleberg.net) is my personal webpage and blog. This
4		website and blog utilize the powerful Org-Mode publishing system,
5		courtesy of the [weblorg](https://github.com/emacs-love/weblorg) Emacs
6		package.
7
8		## Features & Configuration
9
10		This site leverages the flexibility of Org-Mode to allow for easy
11		customization through a simple `publish.el` file. For those
12		who are interested in tweaking the underlying configuration, the weblorg
13		documentation provides all necessary details on possible settings and
14		options.
15
16		## Getting Started
17
18		To begin exploring or contributing to this project, you\'ll first need
19		to set up a local copy of the repository. This can be accomplished by
20		running the following commands within Emacs:
21
22		```shell
23		git clone https://github.com/ccleberg/cleberg.net && \
24		cd cleberg.net && \
25		emacs -nw
26		```
27
28		Alternatively, if you prefer working with Doom, simply open any of the
29		repository files using `Spc f f` and selecting
30		`README.org`. From there, feel free to make any necessary
31		changes or customizations.
32
33		## Building & Publishing the Site
34
35		To test the site locally within Emacs, run the following command
36		sequence:
37
38		Use the `ENV` environment variable to determine which base
39		URL weblorg will use. If ENV is omitted, it will default to
40		`localhost:8000`. If `ENV=prod`, weblorg will look
41		in the `publish.el` file for the production base URL.
42
43		```shell
44		# production:
45		ENV=prod emacs --script publish.el
46
47		# development:
48		emacs --script publish.el
49		```
50
51		The resulting files can then be deployed to your desired target using
52		any method of your choice, such as `scp` or SFTP.
53
54		Alternatively, you may prefer to utilize the provided
55		`build.sh` script to automate this process. To do so, simply
56		customize and run the script as needed.
57
58		```shell
59		# production:
60		ENV=prod ./build.sh
61
62		# development:
63		./build.sh
64		```
65
66		### Creating New Blog Posts
67
68		To quickly create a new blog post within Emacs, follow these steps:
69
70		1. Run `C-x C-f` (`SPC f f` in Doom) to open a
71		new Org-Mode file.
72		2. Utilize the `insert-file-contents` command by pressing
73		`C-x i`.
74		3. Direct the contents of `template.org` (located at
75		`utils/template.org`) into the newly opened file.
76
77		This streamlined process allows you to rapidly generate fresh content
78		for cleberg.net, taking advantage of the existing template structure and
79		formatting.
80
81		## Contributing & Tasks
82
83		For those interested in contributing to this project or addressing any
84		outstanding issues, please refer to the issues tab. This is where you
85		can find a comprehensive list of open tickets or submit a new ticket for
86		consideration.

README.org added +79

		@@ -0,0 +1,79 @@
	1	* cleberg.net
	2
	3	[[https://cleberg.net][cleberg.net]] is my personal web page and blog. This website and blog utilize the
	4	powerful Org-Mode publishing system, courtesy of the [[https://github.com/emacs-love/weblorg][weblorg]] Emacs package.
	5
	6	\| Light Mode \| Dark Mode \|
	7	\|-------------------------+------------------------\|
	8	\| [[./screenshots/light.png]] \| [[./screenshots/dark.png]] \|
	9
	10	** Features & Configuration
	11
	12	This site leverages the flexibility of Org-Mode to allow for easy customization
	13	through a simple =publish.el= file. For those who are interested in tweaking the
	14	underlying configuration, the weblorg documentation provides all necessary
	15	details on possible settings and options.
	16
	17	** Getting Started
	18
	19	To begin exploring or contributing to this project, you'll first need to set up
	20	a local copy of the repository. This can be accomplished by running the
	21	following commands within Emacs:
	22
	23	#+begin_src shell
	24	git clone https://github.com/ccleberg/cleberg.net && \
	25	cd cleberg.net && \
	26	emacs -nw
	27	#+end_src
	28
	29	Alternatively, if you prefer working with Doom, simply open any of the
	30	repository files using =Spc f f= and selecting =README.org=. From there, feel
	31	free to make any necessary changes or customizations.
	32
	33	** Building & Publishing the Site
	34
	35	To test the site locally within Emacs, run the following command sequence:
	36
	37	Use the =ENV= environment variable to determine which base URL weblorg will use.
	38	If ENV is omitted, it will default to =localhost:8000=. If =ENV=prod=, weblorg
	39	will look in the =publish.el= file for the production base URL.
	40
	41	#+begin_src shell
	42	# production:
	43	ENV=prod emacs --script publish.el
	44
	45	# development:
	46	emacs --script publish.el
	47	#+end_src
	48
	49	The resulting files can then be deployed to your desired target using any method
	50	of your choice, such as =scp= or SFTP.
	51
	52	Alternatively, you may prefer to utilize the provided =build.sh= script to
	53	automate this process. To do so, simply customize and run the script as needed.
	54
	55	#+begin_src shell
	56	# production:
	57	ENV=prod ./build.sh
	58
	59	# development:
	60	./build.sh
	61	#+end_src
	62
	63	*** Creating New Blog Posts
	64
	65	To quickly create a new blog post within Emacs, follow these steps:
	66
	67	1. Run =C-x C-f= (=SPC f f= in Doom) to open a new Org-Mode file.
	68	2. Utilize the =insert-file-contents= command by pressing =C-x i=.
	69	3. Direct the contents of =template.org= (located at =utils/template.org=) into
	70	the newly opened file.
	71
	72	This streamlined process allows you to rapidly generate fresh content for
	73	cleberg.net, taking advantage of the existing template structure and formatting.
	74
	75	** Contributing & Tasks
	76
	77	For those interested in contributing to this project or addressing any
	78	outstanding issues, please refer to the issues tab. This is where you can find a
	79	comprehensive list of open tickets or submit a new ticket for consideration.

screenshots/dark.png added

Binary file not shown.

screenshots/light.png added

Binary file not shown.

Commit 6f497dd65e

Commit `6f497dd65e`