Skip to content

Commit

Permalink
Add initial content for solidcouch.org
Browse files Browse the repository at this point in the history
and change layout a bit
  • Loading branch information
mrkvon committed Jul 13, 2024
1 parent 3684ab6 commit d65be8f
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 43 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 mrkvon
Copyright (c) 2024 Solid Couch

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
38 changes: 3 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,5 @@
# Markdown Pages
# Solid Couch

Quickly create and deploy static markdown pages with Next.js
Decentralized hospitality exchange built with [Solid Protocol](https://solidproject.org). Soon, you can also start a community!

## Quick start

### Clone this repository

```
git clone https://github.com/mrkvon/mdpages.git
```

### 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
It's a work in progress. Check out our [github](https://github.com/solidcouch).
Binary file modified src/app/favicon.ico
Binary file not shown.
5 changes: 5 additions & 0 deletions src/app/layout.module.scss
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,10 @@
gap: 2rem;
padding-top: 2rem;
padding-bottom: 1rem;

.attribution {
font-size: smaller;
color: gray;
}
}
}
18 changes: 14 additions & 4 deletions src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,24 @@ export default function RootLayout({
<html lang="en">
<body className={styles.body}>
<header className={styles.header}>
<Link href="/" className={styles.logoContainer}>
<Image src={logo} alt="" width={50} className={styles.logo} />
<Link
href="/"
className={styles.logoContainer}
aria-label="main page"
>
<Image
src={logo}
alt={"logo"}
width={100}
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 className={styles.attribution}>
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.
3 changes: 0 additions & 3 deletions src/content/about.md

This file was deleted.

0 comments on commit d65be8f

Please sign in to comment.