ORG Blog Forge
Table of Contents
- 1. Easy way to create your blog using
- 2. Steps to start
- 2.1. make a blank repo of your choice
- 2.2. add a new README.org file with the following
- 2.3. add a setupfile which is optional
- 2.4. just add/link to the file using
- 2.5. In your init.el or emacs config file put the following
- 2.6. add a bunch of org files.
- 2.7. run
<C-c C-e P p> - 2.8. then push changes.
- 2.9. In Github change the repo settings to public and within settings left pane select pages
- 2.10. under pages
Build and deploymentsection select Github actions - 2.11. then select the main branch.
- 2.12. you will get a link for the blog. copy paste it wherever you want to show it to the world.
- 3. TODOS
- 4. references
2. Steps to start
2.1. make a blank repo of your choice
or Fork this repo to get started.
2.2. add a new README.org file with the following
#+export_file_name: index
2.3. add a setupfile which is optional
to get started I have added some cool themes in the repo. they help you make your pages look better than the plain text which is also completely fine tbh
2.4. just add/link to the file using
#+setupfile: <theme file path>
the option used in this file actually is as follows
setupfile: ./theme-readtheorg.setup
2.5. In your init.el or emacs config file put the following
As we are going to use static HTML all our org files will be dispatched to html using the following setting. just add the source and destination of the .org file and .html file that will be created from them respectively..
(setq org-publish-project-alist '(("my-org-files" ;; Path to the directory containing your Org files :base-directory "~/path/to/where/this/repo/is/cloned" ;; Path to the directory where HTML files will be exported :publishing-directory "~/destination/for/html/files/to/be/exported" :recursive t :publishing-function org-html-publish-to-html :headline-levels 4 ;; Just the default for this project :auto-sitemap t ;; Generate sitemap.org automatically :sitemap-filename "sitemap.org" ;; Name of the sitemap file :sitemap-title "My Sitemap" ;; Title for the sitemap :sitemap-style list))) ;; Style of the sitemap with list, tree, and folder options can be used instead as well.
2.6. add a bunch of org files.
these will be the files that will be basically the pages in your github page. it can be anything, literally.
2.7. run <C-c C-e P p>
this will populate the publishing-directory with final html files created from the .org files.
notice html files, sitemap.org, being created for the repo.
2.8. then push changes.
2.9. In Github change the repo settings to public and within settings left pane select pages
2.10. under pages Build and deployment section select Github actions
2.11. then select the main branch.
- wait for some time.
- refresh
2.12. you will get a link for the blog. copy paste it wherever you want to show it to the world.
3. TODOS
3.1. TODO Add RSS Functionality
3.2. make README just a landing page for all steps list.
3.3. TODO check if denote can be used for ORG Blog Forge.
3.4. TODO Suggestions
3.5. DONE Sample org file linked here
3.6. DONE make a seperate folder for the html files:
this is not possible as github looks for html files in the root and in order to make it look in a seperate folder we need to change the default which would be somehting that i would keep in the scope of the user.