Skip to content

Commit d9f0da3

Browse files
committed
added the README for local build
1 parent b9a6077 commit d9f0da3

File tree

6 files changed

+74
-3
lines changed

6 files changed

+74
-3
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# amFOSS Blog
2+
3+
## Build locally
4+
5+
Follow the following steps to set up and work with this project:
6+
7+
1. Fork, clone or download this project
8+
2. Install [Hexo](https://hexo.io/docs)
9+
3. Install all the dependencies with the command `npm install`
10+
4. Use the command `hexo new post (name of post)`
11+
5. Go to source/_posts to find the generated .md file
12+
6. Use the template given below to write your blog.
13+
7. Run the preview locally: `hexo server`
14+
8. When everything seems fine, sned over a pull request !
15+
16+
## Template for writing your blog post
17+
18+
```
19+
---
20+
title: blog title
21+
date: 2024-07-24 21:05:24
22+
author: name of author
23+
twitter: twitter username
24+
categories:
25+
- Hackathons
26+
tags:
27+
- cython2024
28+
- kochi
29+
- firstplace
30+
---
31+
32+
**tl;dr**
33+
34+
+ something in brief aabout the blog
35+
+ something else (if you want)
36+
37+
<!--more-->
38+
39+
## Blog Description
40+
41+
write the description
42+
43+
```
44+
## General Guidelines:
45+
46+
* Use `<!--more-->` after conveying the important points in the `tl;dr` and add a new line after `tl;dr` and befire <!--more-->.
47+
48+
* Use footnotes with [^1]
49+
50+
* You can choose the Slide HTML by providing it in the front matter.
51+
* slidehtml: true
52+
* slidehtml:
53+
titleMerge: true
54+
verticalSeparator: \n--\n
55+
* slidehtml:
56+
titleMerge: true

source/_posts/My-First-Post.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,9 @@ categories:
66
tags:
77
- FirstPost
88
- FirstTime
9+
author: Hari
10+
twitter: hari
911
---
10-
This is the content of the blog post
12+
13+
This is the content of the blog post
14+

source/author/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Author
3+
layout: author
4+
---

themes/landscape/layout/_partial/article.ejs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@
2121
<% } else { %>
2222
<%- post.content %>
2323
<% } %>
24+
<% if (post.author && post.twitter) { %>
25+
<p>Written by <a href="https://twitter.com/<%- post.twitter %>" target="_blank" rel="noopener noreferrer" id="social_link"><%- post.author %></a></p>
26+
<% } else if (post.author) { %>
27+
<p>Written by <%- post.author %></p>
28+
<% } %>
2429
</div>
2530
<footer class="article-footer">
2631
<a data-url="<%- post.permalink %>" data-id="<%= post._id %>" data-title="<%= post.title %>" class="article-share-link"><span class="fa fa-share"><%= __('share') %></span></a>
@@ -52,4 +57,4 @@
5257
<section id="comments" class="vcomment">
5358
5459
</section>
55-
<% } %>
60+
<% } %>

themes/landscape/source/css/custom.styl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ body.dark-mode .widget-archive a,
9191
body.dark-mode .widget-category a,
9292
body.dark-mode .widget-recent_posts a,
9393
body.dark-mode .widget-tag a,
94-
body.dark-mode .widget-tagcloud a {
94+
body.dark-mode .widget-tagcloud a
95+
body.dark-mode #social_link{
9596
color: #3c83a9;
9697
}
9798

writePost.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import os

0 commit comments

Comments
 (0)