Skip to content

Commit

Permalink
Add initial content and logo
Browse files Browse the repository at this point in the history
  • Loading branch information
mrkvon committed Aug 4, 2024
1 parent 3684ab6 commit d6efdb9
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 56 deletions.
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

38 changes: 6 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,11 @@
# Markdown Pages
# Tired Bike

Quickly create and deploy static markdown pages with Next.js
A decentralized hospitality exchange community for slow travellers and those who want to host them.

## Quick start
## Work In Progress

### Clone this repository
Please check back in the Autumn 2024.

```
git clone https://github.com/mrkvon/mdpages.git
```
There will be a running instance of [SolidCouch](https://solidcouch.org), and you will be able to sign in with your [Solid identity](https://solidproject.org).

### Create contents

- add and change content in `src/content`
- change logo in `src/assets/logo.png`, favicon will be generated from it
- change 404 page in `src/app/404/page.tsx`

### Configure

Copy `.env.local.sample` to `.env.local` and change the variables

You can set up the same variables in your GitHub repository for production

### Preview

```sh
yarn dev
```

### Deploy to GitHub pages

- push the code with your new content to your repository
- set up environment variables in your repository settings
- set up github pages in your repository settings
- if you have custom domain, you need to create DNS records pointing it to github pages, make sure to also set up `HOSTNAME` environment variable
- re-run _Build & Deploy to gh_pages_ workflow
A few things need to be fixed before, so you can use your existing data with Tired Bike, and use other instances of SolidCouch.
Binary file modified src/app/favicon.ico
Binary file not shown.
2 changes: 2 additions & 0 deletions src/app/layout.module.scss
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@
gap: 2rem;
padding-top: 2rem;
padding-bottom: 1rem;
font-size: small;
color: gray;
}
}
7 changes: 4 additions & 3 deletions src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ export default function RootLayout({
<body className={styles.body}>
<header className={styles.header}>
<Link href="/" className={styles.logoContainer}>
<Image src={logo} alt="" width={50} className={styles.logo} />
<Image src={logo} alt="" height={50} className={styles.logo} />
</Link>
</header>
<section className={styles.content}>{children}</section>
<footer className={styles.footer}>
<Link href="/about">about</Link>
<a href="https://github.com/mrkvon/mdpages">mdpages</a>
<span>
Created with <a href="https://github.com/mrkvon/mdpages">mdpages</a>
</span>
</footer>
</body>
</html>
Expand Down
Binary file modified src/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d6efdb9

Please sign in to comment.