Skip to content

README.md

Latest commit

 

History

History
80 lines (62 loc) · 3.42 KB

README.md

File metadata and controls

80 lines (62 loc) · 3.42 KB
Raw

OpenRecruiterTools.github.io

The landing site for the Open Recruiter Tools organisation, served by GitHub Pages at https://openrecruitertools.github.io/.

This is the organisation's user site, so it owns the root of that domain. Every tool repo that publishes its own Pages site appears underneath it, e.g. https://openrecruitertools.github.io/linkedin-unfollow/. Nothing in this repo affects those pages; they are deployed from their own repositories.

What's in here

File What it is
index.html The whole page. Hand-written HTML, no templating.
styles.css Shared stylesheet, extracted from the LinkedIn Unfollow landing page so every site in the org looks like one family.
assets/wordmark.svg The wordmark (mark + name).
assets/og.svg Source for the social card.
assets/og.png The social card referenced by the og:image tag, rendered from og.svg.
.nojekyll Publish the files exactly as they are; skip Jekyll.
.github/workflows/pages.yml Deploys the repository root to Pages on every push to main.

There is no build step, no JavaScript, no framework, no analytics, and no external requests of any kind. Edit the HTML, open it in a browser, commit.

The favicon is an inline SVG data URI in index.html, so the page needs no icon file.

Running it locally

Open index.html in a browser. That is all — there is no server to start. If you would rather serve it over HTTP:

python -m http.server 8000
# then visit http://localhost:8000/

Adding a tool card

Tool cards live in the <div class="grid two"> block under <h2 id="tools"> in index.html. Copy an existing card and change four things — name, what it does, what it never sends, and the two links:

<div class="card tool">
  <h3>Tool Name</h3>
  <p>One line on what it does, in plain language, from the recruiter's point of view.</p>
  <p class="never">
    <strong>Never sends:</strong> what stays on the user's machine.
  </p>
  <p class="tool-links">
    <a class="pill" href="https://openrecruitertools.github.io/tool-name/">Guide</a>
    <a class="pill" href="https://github.com/OpenRecruiterTools/tool-name">Source</a>
  </p>
</div>

Conventions worth keeping:

  • Guide points at the tool's own Pages site where it has one; otherwise at the repo README (https://github.com/OpenRecruiterTools/<repo>#readme). Source always points at the repo.
  • Every tool card carries a "never sends" line. If a tool cannot honestly have one, it does not belong in the organisation.
  • A tool that does not exist yet gets class="card tool coming", a <span class="badge">Coming</span> after the name, and a sentence saying plainly that it is not built yet. Never link a "coming" card to a repository that does not exist.
  • Also add the tool to the org profile README in the openrecruitertools-github repo, so the two lists agree.

Deployment

Pushing to main runs .github/workflows/pages.yml, which uploads the repository root as a Pages artifact and deploys it. In the repository settings, Pages → Build and deployment → Source must be set to GitHub Actions.

There is no CNAME file: the site is served on openrecruitertools.github.io, not a custom domain. Adding one would move the whole organisation's Pages sites onto that domain and break the tool URLs above, so leave it out unless that is deliberately what you want.

MIT licensed.