Skip to content

Commit

Permalink
πŸ¦·πŸ‘¨πŸ»β€πŸ’» ↝ Hugo setup & config
Browse files Browse the repository at this point in the history
  • Loading branch information
Gizmotronn committed Sep 13, 2023
1 parent 2e60658 commit 9d010bf
Show file tree
Hide file tree
Showing 85 changed files with 4,380 additions and 28,884 deletions.
21 changes: 21 additions & 0 deletions 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.
121 changes: 119 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,119 @@
# ShowM3
Web3 based image/media sharing [social media] platform for web3 projects. Building with different open CMSs to build/design UI/UX (e.g. Sanity) before moving to Enjin & Moralis for deeper integration with [my game](https://github.com/signal-k/marketplace). Allows for your project's web3 components to be deeply integrated in a social media for your users that can even stretch into Discord, Slack, etc (using Matrix) in one beautiful package <!--Apps, widgets, etc-->
<div align="center">
<p><a href="https://kee.so/" target="_blank"><img src="https://i.imgur.com/x5SRUoo.png" alt="kee.so" /></a></p>

Create now ➫ [πŸ”— kee.so](https://kee.so/)

</div>

---

<div align="center">
<h1>Paper <sup><sup><sub>6.21</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/screenshot_mobile.png)
![](./images/pagespeed.png)

## Options

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

```toml
disqusShortname = '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'
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/'
graphCommentId = "YOUR_GRAPH_COMMENT_ID" # use graph comment (disqus alternative)
math = true # enable KaTeX math typesetting globally
```

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 hugo module

Inside the folder of your Hugo project, run:

```bash
hugo mod init github.com/<USERNAME>/<REPONAME>
```

Add paper theme ad dependency of your site:

```bash
hugo mod init github.com/<USERNAME>/<REPONAME>
```

Open `config.toml` or `hugo.toml`, remove the `theme` line (if present) and add module section at 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.

### 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.

## License

[MIT License](https://github.com/nanxiaobei/hugo-paper/blob/main/LICENSE) (c) [nanxiaobei](https://lee.so/)
88 changes: 88 additions & 0 deletions assets/app.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* 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 {
html,
body {
@apply h-full;
}

html {
--bg: transparent;
}

body {
-webkit-tap-highlight-color: transparent;
background: var(--bg);

@apply dark:bg-black/90;
}
}

@layer components {
.btn {
@apply rounded-full bg-black px-7 py-4 text-sm text-white no-underline shadow 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;
}

.highlight tr {
border-bottom-width: 0;
}

.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 pre:not(blockquote pre) {
@apply -mx-8 !p-8 shadow;
}

article blockquote {
padding-left: calc(theme('space.8') - 3px) !important;
margin-left: calc(theme('space.8') * -1) !important;

@apply !border-black dark:!border-white;
}
}
1 change: 1 addition & 0 deletions 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 9d010bf

Please sign in to comment.