Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
salif committed Dec 11, 2024
1 parent 1b44f44 commit f212fb7
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[submodule "themes/linkita"]
path = themes/linkita
url = https://codeberg.org/salif/linkita.git
branch = linkita
Empty file removed .nojekyll
Empty file.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,26 @@
- [Zola Themes Collection](https://salif.github.io/zola-themes-collection/)
- [Kita theme](https://github.com/st1020/kita)
- [Hugo-Paper theme](https://github.com/nanxiaobei/hugo-paper)

## Set up for contributing

Fork this demo repository and/or the theme repository.

Replace `YOUR-USERNAME`:

```sh
# Step 1:
# If you forked the demo repository:
git clone --recurse-submodules https://codeberg.org/YOUR-USERNAME/linkita-demo.git
# Otherwise:
git clone --recurse-submodules https://codeberg.org/salif/linkita-demo.git

# Step 2: Only if you forked the theme repository:
cd linkita-demo/themes/linkita
git remote add downstream https://codeberg.org/YOUR-USERNAME/linkita.git

# If you do changes in the theme repository:
git checkout -b feature
git commit
git push downstream feature
```
15 changes: 12 additions & 3 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,20 @@ serve-and args='':
[group('dev')]
serve: serve-and

[doc('git push')]
[group('dev')]
zola-check:
command {{ zola }} check

[doc('git commit')]
[group('git')]
commit-demo: zola-check format
command {{ git }} commit

[doc('git push')]
[group('git')]
push-demo:
command {{ git }} push codeberg-demo demo
command {{ git }} push github demo
command {{ git }} push codeberg-demo demo:demo
command {{ git }} push github demo:demo

[doc('Format source code')]
[group('dev')]
Expand Down
2 changes: 1 addition & 1 deletion themes/linkita
Submodule linkita updated from 663cdb to 552b60

0 comments on commit f212fb7

Please sign in to comment.