agentleFS
kitian616kitian616/jekyll-TeXt-theme/CLAUDE.md

jekyll-TeXt-theme

CLAUDE.md3.3k starsChanged 8 years agoMITView on GitHub

CI: Travis builds the docs site via JEKYLL_ENV=production bundle exec jekyll build --config ./docs/_config.yml and deploys to gh-pages branch. Commit style: Conventional Commits via commitlint (feat:, fix:, docs:, refactor:, release:, etc.). No bundler — all JS is served raw from _includes/scripts/.

Trending

Quiet this year.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 0 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the kitian616/jekyll-TeXt-theme repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about kitian616/jekyll-TeXt-theme

The biggest 5 of 15 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 15

Talked about on GitHub and Hacker News (15 times).

On GitHub · 14

9 more on GitHub

The file

We split this CLAUDE.md into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No bundler — all JS is served raw from _includes/scripts/.

    line 71
  2. Very specific:

    Update version in jekyll-text-theme.gemspec, package.json, and _includes/scripts/variables.html

    line 90

≈ “Common” is an estimate: at least 1 in 5 of the 27,641 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

# Build the production site
npm run build

# Serve locally with live reload (default)
npm run serve

# Serve with tracing output
npm run default

# Serve docs/demo site (dev, beta, production variants)
npm run dev          # docs/_config.dev.yml
npm run demo-dev     # docs/_config.yml (dev env)
npm run demo-prod    # docs/_config.yml (production env)

# Lint JS in _includes/**/*.js
npm run eslint
npm run eslint-fix

# Lint SCSS in _sass/**/*.scss
npm run stylelint
npm run stylelint-fix

# Build & publish gem (release flow only)
npm run gem-build
npm run gem-push

# Docker-based development
npm run docker-dev:default
npm run docker-dev:dev
npm run docker-dev:demo-dev

# Docker production build + serve
npm run docker-prod:build
npm run docker-prod:serve

CI: Travis builds the docs site via JEKYLL_ENV=production bundle exec jekyll build --config ./docs/_config.yml and deploys to gh-pages branch.

Commit style: Conventional Commits via commitlint (feat:, fix:, docs:, refactor:, release:, etc.).

Project Architecture

Skin System

6 built-in skins (default, dark, forest, ocean, chocolate, orange) + 5 highlight themes. A skin is a SCSS file at _sass/skins/_<name>.scss that defines CSS custom properties (colors, fonts, borders). Selected via text_skin in _config.yml. The main entry point assets/css/main.scss dynamically @imports the active skin.

Layout Inheritance

Layouts in _layouts/ form a chain: none ← base ← page ← article / home / landing / articles / archive / 404. base.html is the root — it sets up the HTML shell, analytics, head, and core JS utilities. Page-level layouts extend it and add content wrappers.

Include System

_includes/ is organized by concern:

  • article/ — header, footer, info, list components
  • aside/ — sidebar content (TOC, affix)
  • scripts/ — vanilla JS (no framework): lib/ (third-party), utils/, components/ (search, lightbox, sidebar)
  • head/, footer/, sidebar/ — structural includes
  • comments-providers/, analytics-providers/, search-providers/, sharing-providers/, pageview-providers/ — pluggable third-party integrations

JavaScript Architecture

Vanilla JS (no build step, no framework). Scripts are included directly via Liquid {%- include scripts/...js -%} in base.html. The JS is split into:

  • lib/ — isolated utilities (lazyload, throttle, affix, TOC, swiper, modal, gallery, scroll-to)
  • components/ — stateful UI (search, lightbox, sidebar)
  • utils/ — helpers (image loading, general utils)
  • Page-level scripts: article.js, page.js, home.js, archieve.js

No bundler — all JS is served raw from _includes/scripts/.

SCSS Organization

_sass/ is structured as:

  • skins/ — color/font themes (each skin is a standalone variable file)
  • common/ — shared variables, functions, classes, reset, print styles, reusable components (button, card, modal, gallery, etc.)
  • components/ — page-level component styles (header, footer, search, lightbox, etc.)
  • layout/ — page layout styles (base, page, article, home, archive, etc.)
  • additional/ — optional utility styles (alerts, tags, photo frames)
  • animate/ — keyframe animations (fade-in variants)
  • custom.scss — user overrides placeholder

Content & Data

  • _data/ — YAML files for authors, licenses, locale (i18n), navigation, and theme variables
  • _posts/ — sample/blog posts directory
  • docs/ — standalone documentation site (has its own _config.yml, posts, sample pages, and shared _includes from root via Travis before_script)
  • test/ — minimal test site (used for smoke testing the theme)

Building a Release

  1. Update version in jekyll-text-theme.gemspec, package.json, and _includes/scripts/variables.html
  2. Update CHANGELOG.md
  3. Run npm run gem-build && npm run gem-push
  4. Tag and push with release: vx.x.x commit message

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.