programming-pages

KO | EN

gitlite — search

#python #react #typescript #go #rust #deep-learning #nodejs #macos #java #cli #awesome-list #pytorch #mcp #open-source

programming-pages

(★ 15)

a jekyll theme for publishing code documentation to GitHub pages

programming-pages 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# programming-pages

a Jekyll theme for publishing code documentation to GitHub pages

> See **programming pages** used to document itself here: https://pixeldroid.github.io/programming-pages/

[![screenshot][screenshot]][programming-pages-docs]

[installation](#installation) | [usage](#usage) | [building](#building) | [contributing](#contributing)

## installation

### as a remote theme

Specify `pixeldroid/programming-pages` as your remote theme in `_config.yml`:

```yml
plugins:
  - jekyll-remote-theme

remote_theme: pixeldroid/programming-pages
```

### as a gem

Follow the Jekyll directions for [installing a gem-based theme][jekyll-theme]

`Gemfile`:

```ruby
gem 'programming-pages'
```

`_config.yml`:

```yml
theme: programming-pages
```

### as a local copy of the files

1. Download the latest [release][releases]
1. Extract it into your project under a folder of your choice (e.g. `docs/`)

## usage

> first: 
> 1. [Configure a publishing source for GitHub Pages][ghpages-howto] so GitHub knows where to find your documentation.

1. [Author documentation][author-documentation]
1. [Push to GitHub][push-to-github]
1. Visit your documentation site at https://&lt;`username`&gt;.github.io/&lt;`project`&gt;
1. _repeat_

---

> If you just want to use the theme, you can stop reading here. 
> The directions below are only useful if you're interested in building the theme from source.

---

## building

**programming pages** depends on [Jekyll][jekyll], [Semantic UI][semantic], and [jQuery][jquery].
The dependencies are all captured and coordinated in the source of this project,
but if you want to update a dependency or change its configuration,
you'll need to be able to build them from source.

### building the static site locally

> first: 
> 1. [install jekyll][jekyll-install] and the [github-pages gem][ghpages-install]: `bundle install`

```console
rake docs
open http://localhost:4000/
```

### generating the semantic ui files

> first: 
> 1. ensure you can [build semantic ui][semantic-build] (requires nodejs, npm, gulp): `gulp build`
> 1. check out the [programming-pages branch of the pixeldroid fork][semantic-custom] of semantic ui

```console
rake semantic['/path/to/programming-pages-semantic']
```

#### semantic ui modules

The Semantic UI modules required by this project are declared in `build/semantic/semantic.json`.

### generating the jQuery file

> first 
> 1. ensure you can [build jQuery][jquery-build] (requires nodejs, grunt): `grunt default`

```console
grunt custom:-ajax,-wrap remove_map_comment
cp /path/to/jquery/dist/jquery.min.js /path/to/programming-pages/_includes/scripts/jquery/jquery-<version>.custom.min.js
```

Don't forget to update `assets/site.js` with the new filename.

#### jQuery modules

> Smaller custom subsets of the jQuery library can be built by excluding unwanted modules.
> (see https://github.com/jquery/jquery#modules)

This project excludes the following unused modules to reduce file size:

##### excluded
- `ajax`
- `wrap`

##### required
- `attr`
- `classes`
- `core`
- `css`
- `data`
- `deferred` (required for `effects`)
- `deprecated` (for jQuery Address's use of `bind`)
- `dimensions`
- `effects`
- `events`
- `filtering`
- `init`
- `manipulation`
- `offsets`
- `parseHTML`
- `prop`
- `ready`
- `traversing`
- `val`

## contributing

[Pull requests][pull-requests] for improved documentation, bug fixes and useful features are all welcome. :gift_heart:

[author-documentation]: https://pixeldroid.github.io/programming-pages/guides/Authoring-Documentation/#/guides/ "Authoring documentation using the programming pages site template"
[ghpages-howto]: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/ "How to Configure a publishing source for GitHub Pages"
[ghpages-install]: https://github.com/github/pages-gem "GitHub Pages Ruby Gem"
[jekyll]: https://jekyllrb.com/ "Simple, blog-aware, static sites"
[jekyll-install]: https://jekyllrb.com/docs/installation/ "How to install Jekyll"
[jekyll-theme]: https://jekyllrb.com/docs/themes/#installing-a-theme "Installing a gem-based theme"
[jquery]: https://github.com/jquery/jquery#how-to-build-your-own-jquery "jQuery is a fast, small, and feature-rich JavaScript library"
[jquery-build]: https://github.com/jquery/jquery#how-to-build-your-own-jquery "How to build your own jQuery"
[programming-pages-docs]: https://pixeldroid.github.io/programming-pages/ "a Jekyll theme for publishing code documentation to GitHub pages"
[pull-requests]: https://github.com/pixeldroid/programming-pages/pulls "Pull requests for the Programming Pages template project"
[push-to-github]: https://help.github.com/articles/pushing-to-a-remote/ "Pushing to a remote"
[releases]: https://github.com/pixeldroid/programming-pages/releases "Packaged releases of the Programming Pages template"
[screenshot]: screenshot.png "screenshot of a programming pages generated site"
[semantic]: https://semantic-ui.com/ "Semantic is a UI component framework based around useful principles from natural language"
[semantic-build]: https://semantic-ui.com/introduction/build-tools.html "Semantic UI build tools"
[semantic-custom]: https://github.com/pixeldroid/Semantic-UI/tree/programming-pages "programming-pages branch of Semantic UI"

programming-pages

programming-pages 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

programming-pages

programming-pages 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README