index.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-15 Thu 19:47 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ORG Blog Forge</title>
<meta name="author" content="Vipul" />
<meta name="generator" content="Org Mode" />
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
</head>
<body>
<div id="content" class="content">
<h1 class="title">ORG Blog Forge</h1>
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orge611d43">1. Easy way to create your blog using</a>
<ul>
<li><a href="#orga8abc57">1.1. ORG mode | Org export dispatch Publish | Github pages.</a></li>
</ul>
</li>
<li><a href="#org610be20">2. Steps to start</a>
<ul>
<li><a href="#orgd64a76f">2.1. make a blank repo of your choice</a></li>
<li><a href="#org9bca1a2">2.2. add a new README.org file with the following</a></li>
<li><a href="#orgf9e9e5f">2.3. add a setupfile which is optional</a></li>
<li><a href="#org71b6d04">2.4. just add/link to the file using</a></li>
<li><a href="#org7022ade">2.5. In your init.el or emacs config file put the following</a></li>
<li><a href="#org01ba5a5">2.6. add a bunch of org files.</a></li>
<li><a href="#orgb19bf50">2.7. run <code>&lt;C-c C-e P p&gt;</code></a></li>
<li><a href="#orgd3a9433">2.8. then push changes.</a></li>
<li><a href="#org79fd97f">2.9. In Github change the repo settings to public and within settings left pane select pages</a></li>
<li><a href="#org6844856">2.10. under pages <code>Build and deployment</code> section select Github actions</a></li>
<li><a href="#org735796a">2.11. then select the main branch.</a></li>
<li><a href="#org000ff40">2.12. you will get a link for the blog. copy paste it wherever you want to show it to the world.</a></li>
</ul>
</li>
<li><a href="#org4b379ab">3. TODOS</a>
<ul>
<li><a href="#orgc60bdd2">3.1. <span class="todo TODO">TODO</span> Add RSS Functionality</a></li>
<li><a href="#orge2f444f">3.2. make README just a landing page for all steps list.</a></li>
<li><a href="#orgf5d9579">3.3. <span class="todo TODO">TODO</span> check if denote can be used for ORG Blog Forge.</a></li>
<li><a href="#org67aeb89">3.4. <span class="todo TODO">TODO</span> Suggestions</a></li>
<li><a href="#org3a31453">3.5. <span class="done DONE">DONE</span> Sample org file linked here</a></li>
<li><a href="#orgc653bc9">3.6. <span class="done DONE">DONE</span> <del>make a seperate folder for the html files:</del></a></li>
</ul>
</li>
<li><a href="#org81a01c1">4. references</a>
<ul>
<li><a href="#org0634d36">4.1. Jethro kuan</a></li>
<li><a href="#org8829f5e">4.2. Fabrice Niessen</a></li>
<li><a href="#org5d0969c">4.3. spudlyo</a></li>
<li><a href="#org99ac1ee">4.4. minad for example.org file</a></li>
<li><a href="#orge862165">4.5. prot :)</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orge611d43" class="outline-2">
<h2 id="orge611d43"><span class="section-number-2">1.</span> Easy way to create your blog using</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-orga8abc57" class="outline-3">
<h3 id="orga8abc57"><span class="section-number-3">1.1.</span> <a href="https://orgmode.org/">ORG mode</a> | <a href="https://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.html">Org export dispatch Publish</a> | <a href="https://pages.github.com/">Github pages.</a></h3>
</div>
</div>
<div id="outline-container-org610be20" class="outline-2">
<h2 id="org610be20"><span class="section-number-2">2.</span> Steps to start</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-orgd64a76f" class="outline-3">
<h3 id="orgd64a76f"><span class="section-number-3">2.1.</span> make a blank repo of your choice</h3>
<div class="outline-text-3" id="text-2-1">
<p>
or Fork this repo to get started.
</p>
</div>
</div>
<div id="outline-container-org9bca1a2" class="outline-3">
<h3 id="org9bca1a2"><span class="section-number-3">2.2.</span> add a new README.org file with the following</h3>
<div class="outline-text-3" id="text-2-2">
<div class="org-src-container">
<pre class="src src-emacs-lisp">#+export_file_name: index
</pre>
</div>
</div>
</div>
<div id="outline-container-orgf9e9e5f" class="outline-3">
<h3 id="orgf9e9e5f"><span class="section-number-3">2.3.</span> add a setupfile which is optional</h3>
<div class="outline-text-3" id="text-2-3">
<p>
to get started I have added <a href="org-html-themes/">some cool themes</a> in the repo. they help you make your pages look better than the plain text which is also completely fine tbh
</p>
</div>
</div>
<div id="outline-container-org71b6d04" class="outline-3">
<h3 id="org71b6d04"><span class="section-number-3">2.4.</span> just add/link to the file using</h3>
<div class="outline-text-3" id="text-2-4">
<div class="org-src-container">
<pre class="src src-emacs-lisp">#+setupfile: &lt;theme file path&gt;
</pre>
</div>

<p>
the option used in this file actually is as follows
</p>
<pre class="example" id="org029a6de">
setupfile: ./theme-readtheorg.setup
</pre>
</div>
</div>
<div id="outline-container-org7022ade" class="outline-3">
<h3 id="org7022ade"><span class="section-number-3">2.5.</span> In your init.el or emacs config file put the following</h3>
<div class="outline-text-3" id="text-2-5">
<p>
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 <span class="underline">.org</span> file and <span class="underline">.html</span> file that will be created from them respectively..
</p>

<div class="org-src-container">
<pre class="src src-emacs-lisp">(<span style="color: #531ab6; font-weight: bold;">setq</span> org-publish-project-alist
      '((<span style="color: #3548cf;">"my-org-files"</span>
         <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Path to the directory containing your Org files</span>
         <span style="color: #8f0075; font-weight: bold;">:base-directory</span> <span style="color: #3548cf;">"~/path/to/where/this/repo/is/cloned"</span>
         <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Path to the directory where HTML files will be exported</span>
         <span style="color: #8f0075; font-weight: bold;">:publishing-directory</span> <span style="color: #3548cf;">"~/destination/for/html/files/to/be/exported"</span>
         <span style="color: #8f0075; font-weight: bold;">:recursive</span> t
         <span style="color: #8f0075; font-weight: bold;">:publishing-function</span> org-html-publish-to-html
         <span style="color: #8f0075; font-weight: bold;">:headline-levels</span> 4  <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Just the default for this project</span>
         <span style="color: #8f0075; font-weight: bold;">:auto-sitemap</span> t     <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Generate sitemap.org automatically</span>
         <span style="color: #8f0075; font-weight: bold;">:sitemap-filename</span> <span style="color: #3548cf;">"sitemap.org"</span>  <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Name of the sitemap file</span>
         <span style="color: #8f0075; font-weight: bold;">:sitemap-title</span> <span style="color: #3548cf;">"My Sitemap"</span>  <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Title for the sitemap</span>
         <span style="color: #8f0075; font-weight: bold;">:sitemap-style</span> list)))  <span style="color: #595959; font-style: italic;">;; </span><span style="color: #595959; font-style: italic;">Style of the sitemap with list, tree, and folder options can be used instead as well.</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-org01ba5a5" class="outline-3">
<h3 id="org01ba5a5"><span class="section-number-3">2.6.</span> add a bunch of org files.</h3>
<div class="outline-text-3" id="text-2-6">
<p>
these will be the files that will be basically the pages in your github page. it can be anything, literally.
</p>
</div>
</div>
<div id="outline-container-orgb19bf50" class="outline-3">
<h3 id="orgb19bf50"><span class="section-number-3">2.7.</span> run <code>&lt;C-c C-e P p&gt;</code></h3>
<div class="outline-text-3" id="text-2-7">
<p>
this will populate the <b>publishing-directory</b> with final html files created from the <b>.org</b> files.
</p>
<blockquote>
<p>
notice html files, sitemap.org, being created for the repo.
</p>
</blockquote>
</div>
</div>
<div id="outline-container-orgd3a9433" class="outline-3">
<h3 id="orgd3a9433"><span class="section-number-3">2.8.</span> then push changes.</h3>
</div>
<div id="outline-container-org79fd97f" class="outline-3">
<h3 id="org79fd97f"><span class="section-number-3">2.9.</span> In Github change the repo settings to public and within settings left pane select pages</h3>
</div>
<div id="outline-container-org6844856" class="outline-3">
<h3 id="org6844856"><span class="section-number-3">2.10.</span> under pages <code>Build and deployment</code> section select Github actions</h3>
</div>
<div id="outline-container-org735796a" class="outline-3">
<h3 id="org735796a"><span class="section-number-3">2.11.</span> then select the main branch.</h3>
<div class="outline-text-3" id="text-2-11">
<ul class="org-ul">
<li>wait for some time.</li>
<li>refresh</li>
</ul>
</div>
</div>
<div id="outline-container-org000ff40" class="outline-3">
<h3 id="org000ff40"><span class="section-number-3">2.12.</span> you will get a link for the blog. copy paste it wherever you want to show it to the world.</h3>
</div>
</div>
<div id="outline-container-org4b379ab" class="outline-2">
<h2 id="org4b379ab"><span class="section-number-2">3.</span> TODOS</h2>
<div class="outline-text-2" id="text-3">
</div>
<div id="outline-container-orgc60bdd2" class="outline-3">
<h3 id="orgc60bdd2"><span class="section-number-3">3.1.</span> <span class="todo TODO">TODO</span> Add RSS Functionality</h3>
<div class="outline-text-3" id="text-3-1">
<p>
<a href="rss-to-be-added-study.html">rss adding learnings</a>
</p>
</div>
</div>
<div id="outline-container-orge2f444f" class="outline-3">
<h3 id="orge2f444f"><span class="section-number-3">3.2.</span> make <a href="README.html">README</a> just a landing page for all steps list.</h3>
</div>
<div id="outline-container-orgf5d9579" class="outline-3">
<h3 id="orgf5d9579"><span class="section-number-3">3.3.</span> <span class="todo TODO">TODO</span> check if <a href="https://github.com/protesilaos/denote">denote</a> can be used for <a href="https://onlyvip.github.io/Org-Blog-Forge/">ORG Blog Forge</a>.</h3>
</div>
<div id="outline-container-org67aeb89" class="outline-3">
<h3 id="org67aeb89"><span class="section-number-3">3.4.</span> <span class="todo TODO">TODO</span> Suggestions</h3>
</div>
<div id="outline-container-org3a31453" class="outline-3">
<h3 id="org3a31453"><span class="section-number-3">3.5.</span> <span class="done DONE">DONE</span> <a href="sample-readme.html">Sample org file linked here</a></h3>
</div>
<div id="outline-container-orgc653bc9" class="outline-3">
<h3 id="orgc653bc9"><span class="section-number-3">3.6.</span> <span class="done DONE">DONE</span> <del>make a seperate folder for the html files:</del></h3>
<div class="outline-text-3" id="text-3-6">
<blockquote>
<p>
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.
</p>
</blockquote>
</div>
</div>
</div>
<div id="outline-container-org81a01c1" class="outline-2">
<h2 id="org81a01c1"><span class="section-number-2">4.</span> references</h2>
<div class="outline-text-2" id="text-4">
<p>
Thanks to
</p>
</div>
<div id="outline-container-org0634d36" class="outline-3">
<h3 id="org0634d36"><span class="section-number-3">4.1.</span> <a href="https://github.com/jethrokuan">Jethro kuan</a></h3>
</div>
<div id="outline-container-org8829f5e" class="outline-3">
<h3 id="org8829f5e"><span class="section-number-3">4.2.</span> <a href="https://github.com/fniessen/org-html-themes">Fabrice Niessen</a></h3>
</div>
<div id="outline-container-org5d0969c" class="outline-3">
<h3 id="org5d0969c"><span class="section-number-3">4.3.</span> <a href="https://github.com/spudlyo/orgdemo2">spudlyo</a></h3>
</div>
<div id="outline-container-org99ac1ee" class="outline-3">
<h3 id="org99ac1ee"><span class="section-number-3">4.4.</span> <a href="https://github.com/minad/org-modern">minad for example.org file</a></h3>
</div>
<div id="outline-container-orge862165" class="outline-3">
<h3 id="orge862165"><span class="section-number-3">4.5.</span> <a href="https://github.com/protesilaos">prot :)</a></h3>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Date: 2024-08-12 Mon 08:14</p>
<p class="author">Author: Vipul</p>
<p class="date">Created: 2024-08-15 Thu 19:47</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>