Skip to content

Commit

Permalink
Add the theme files that we excluded
Browse files Browse the repository at this point in the history
  • Loading branch information
Masood Azizi committed Jan 9, 2025
1 parent 4ee778b commit 9db2515
Show file tree
Hide file tree
Showing 82 changed files with 4,587 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
hugo-version: "latest"

- name: Build
run: hugo
run: hugo

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
public/
*.code-workspace
21 changes: 21 additions & 0 deletions themes/paper/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 南小北

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
132 changes: 132 additions & 0 deletions themes/paper/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<div align="center">

Link in bio to **widgets**,
your online **home screen**. ➫ [kee.so](https://kee.so/)

</div>

---

<div align="center">
<h1>Paper <sup><sup><sub>6.28</sub></sup></sup></h1>

Demo → [hugo-paper.vercel.app](https://hugo-paper.vercel.app/)

A simple, clean, customizable Hugo theme.

⚡️ Fast | 👒 Customizable | 🫙 Smooth

</div>

## Links

Product Hunt: [producthunt.com/posts/hugo-paper-6](https://www.producthunt.com/posts/hugo-paper-6)

Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)

## Overview

![](./images/screenshot.png)
![](./images/screenshot_dark.png)
![](./images/pagespeed.png)

## Options

Available options to `config.toml` or `hugo.toml`:

```toml
[services]
[services.disqus]
shortname = 'YOUR_DISQUS_SHORTNAME' # use disqus comments

[params]
# color style
color = 'linen' # linen, wheat, gray, light

# header social icons
twitter = 'YOUR_TWITTER_ID' # twitter.com/YOUR_TWITTER_ID
github = 'YOUR_GITHUB_ID' # github.com/YOUR_GITHUB_ID
instagram = 'YOUR_INSTAGRAM_ID' # instagram.com/YOUR_INSTAGRAM_ID
linkedin = 'YOUR_LINKEDIN_ID' # linkedin.com/in/YOUR_LINKEDIN_ID
mastodon = 'YOUR_MASTODON_LINK' # e.g. 'https://mastodon.instance/@xxx'
threads = '@YOUR_THREADS_ID' # threads.net/@YOUR_THREADS_ID
bluesky = 'YOUR_BLUESKY_ID' # https://bsky.app/profile/YOUR_BLUESKY_ID
rss = true # show rss icon

# home page profile
avatar = 'GRAVATAR_EMAIL' # gravatar email or image url
name = 'YOUR_NAME'
bio = 'YOUR_BIO'


# misc
disableHLJS = true # disable highlight.js
disablePostNavigation = true # disable post navigation
monoDarkIcon = true # show monochrome dark mode icon
gravatarCdn = 'GRAVATAR_CDN_LINK' # e.g. 'https://cdn.v2ex.com/gravatar/'
math = true # enable KaTeX math typesetting globally
localKatex = false # use local KaTeX js/css instead of CDN
graphCommentId = "YOUR_GRAPH_COMMENT_ID" # use graph comment (disqus alternative)
favicon = "favicon.ico" # customize the default favicon
appleTouchIcon = "apple-touch-icon.png" # customize the default Apple touch icon

# RTL supprot
direction = "rtl" # RTL support for Right-to-left languages

# giscus
[params.giscus]
repo = 'YOUR_GISCUS_REPO' # see https://giscus.app for more details
repoId = 'YOUR_GISCUS_REPO_ID'
category = 'YOUR__GISCUS_CATEGORY'
categoryId = 'YOUR_GISCUS_CATEGORY_ID'
mapping = 'pathname'
theme = 'light'
lang = 'zh-CN'
```

Available options to front matter:

```toml
comments = false # disable comments for a specific page
math = true # enable KaTeX math typesetting for a specific page
```

## Install

### As git submodule

Inside the folder of your Hugo project, run:

```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```

Open `config.toml`(or `hugo.toml`), change `theme` to `"paper"`:

```toml
theme = "paper"
```

For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#configure-the-site) of Hugo.

### As hugo module

Add paper theme ad dependency of your site:

```bash
hugo mod init github.com/<your_user>/<your_project>
```

Open `config.toml`(or `hugo.toml`), remove the `theme` line (if present), add `module` section to the bottom of the file:

```toml
[module]
[[module.imports]]
path = "github.com/nanxiaobei/hugo-paper"
```

For more information, please read the [official guide](https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme) of Hugo.

## License

[MIT License](https://github.com/nanxiaobei/hugo-paper/blob/main/LICENSE) (c) [nanxiaobei](https://lee.so/)
129 changes: 129 additions & 0 deletions themes/paper/assets/app.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
/*
* Paper
* A simple, clean, flexible Hugo theme
* https://github.com/nanxiaobei/hugo-paper
* Designed by 南小北 https://lee.so/
*/

@tailwind base;
@tailwind components;
@tailwind utilities;

@layer base {
:root {
--w: calc(680px + 32px * 2);
}

body {
@apply bg-[--bg] antialiased [-webkit-tap-highlight-color:transparent];

@apply dark:before:fixed dark:before:inset-0 dark:before:bg-black/85;
}

h1,
h2,
h3 {
@apply !font-semibold;
}

pre {
direction: ltr;
}
}

@layer components {
.btn {
@apply rounded-xl bg-black px-5 py-3 text-[0.95em] text-white no-underline duration-100 active:scale-95 dark:bg-white dark:text-black;
}

.link {
@apply duration-200 hover:text-black dark:hover:text-white;
}
}

@layer utilities {
.not-ready * {
@apply !transition-none;
}

.prose {
@apply break-words;
}

.prose kbd:has(kbd) {
@apply shadow-none;
}

.btn-menu::before,
.btn-menu::after {
@apply block h-[2px] w-5 bg-black duration-200 content-[''] dark:invert;
}

.nav-wrapper {
background: var(--bg);
}

.open {
@apply overflow-hidden;
}

.open .btn-menu::before {
@apply w-6 translate-y-[5.5px] rotate-45;
}

.open .btn-menu::after {
@apply w-6 -translate-y-[5.5px] -rotate-45;
}

.open .nav-wrapper {
@apply top-0;
}

article {
@apply text-lg leading-[1.8] text-black dark:text-white;
}

article code {
@apply inline-block !text-sm !leading-6;
}

article .highlight {
@apply my-8;

pre {
@apply my-0;
}

> div {
@apply rounded-md bg-[--tw-prose-pre-bg];

table {
@apply my-0 table-fixed;

tr {
@apply flex;

td {
@apply p-0;

pre {
@apply !bg-transparent;
}
}

&:first-of-type pre {
@apply pr-[4px];

code span {
@apply !mr-0 block min-w-[18px] !p-0 text-right text-white/40;
}
}

&:last-of-type {
@apply overflow-auto;
}
}
}
}
}
}
1 change: 1 addition & 0 deletions themes/paper/assets/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* Place custom css here. */
Loading

0 comments on commit 9db2515

Please sign in to comment.