Skip to content

Commit

Permalink
docs(readme): some final touches
Browse files Browse the repository at this point in the history
  • Loading branch information
ajhalili2006 authored Dec 31, 2024
1 parent c76cf5b commit e05d4ce
Showing 1 changed file with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,37 @@
# @recaptime-dev/website
# `@recaptime-dev/website`

> **Came here from [High Seas] and looking for the `@recaptime-dev/squad` project repository?**
> It is in <https://github.com/recaptime-dev/squad>, currently serves as a meta repository
> for the crew and the single source of truth for our profile READMEs (but not for our
> team-wide meta issue tracker), similarly to [Hack Club's] and [Open Collective's].
>
> - Andrei Jiroh (@ajhalili2006 on Slack)
[High Seas]: https://highseas.hackclub.com
[Hack Club's]: https://github.com/hackclub/hackclub
[Open Collective's]: https://github.com/opencollective/opencollective

[![Cloudflare Pages](https://github.com/recaptime-dev/website-next/actions/workflows/cf-pages.yml/badge.svg)](https://github.com/recaptime-dev/website-next/actions/workflows/cf-pages.yml)

Jekyll-based website for Recap Time Squad, with the [JTD theme]. If you're looking for
the old codebase, [go to `arhcived/old-theme` branch][old-code].
RecapTime.dev website sources, built with [Material for Mkdocs]. Previously on
Jekyll with [Just the Docs] and [Type on Strap] themes.

[Material for Mkdocs]: https://squidfunk.github.io/mkdocs-material/

## Development

See [`CONTRIBUTING.md`](./CONTRIBUTING.md) file for full details. In nutshell:

1. Install dependencies: `bundle install`
2. Run localdev: `bundle exec jekyll serve --watch --livereload --drafts --unpublished`
3. Edit as needed (Markdown files are at `docs` directory with `permnalink` magic)
1. Install dependencies: `pipenv install` (Make sure to have Python 3.13 installed)
2. Run localdev: `pipenv run dev`
3. Edit as needed (Markdown files are at `src` directory)
4. Signoff your commits and push to your personal fork.
5. Send a merge request or email patch.

[JTD theme]: https://just-the-docs.github.io/just-the-docs/
[old-code]: https://github.com/recaptime-dev/website-next/commits/archived/old-theme
[Just The Docs]: ./archived
[Type on Strap]: https://github.com/recaptime-dev/website-next/tree/archived/old-theme

## License

* Website: CC-BY-SA-4.0
* Source repo: MPL-2.0

0 comments on commit e05d4ce

Please sign in to comment.