bpkg/bpkg.github.io

Homepage for the bpkg project http://bpkg.sh

bpkg.github.io (bpkg.sh)

bpkg is a lightweight bash package manager. This repository contains the source code of it's homepage.

Links

• bpkg homepage;
• bpkg source code on GitHub;
• bpkg organization on GitHub;

bpkg Commands

To assist in working with this project, A bpkg.json file has been included with commonly used project commands. The provided commands can be executed using the following format:

$ bpkg run [COMMAND]

In the remainder of this document, if there is a accompanying bpkg command it will be listed as follows:

BPKG: [COMMAND]

Docker Environment

This environment is not necessary to use if you'd rather run everything directly on your host system. This environment is provided however, to facilitate all the required components for building and development of bpkg site.

A docker-composer.yml file exists in the root directory of the project to specify the Docker services

• jekyll – Perform Jekyll and Rake processes

  NOTE: A custom Dockerfile exists to generate the image for this service, in the dev/jekyll directory

• lessc – Implements LESS preprocessing
• sitediff – Host SiteDiff for performing site comparison

There are associated bpkg commands to interact with the Docker environments, accompanying Docker commands will be listed like the other bpkg commands.

Dependencies

This website was made with the Jekyll engine, so it depends on a few Ruby Gems. To install them, run the following command:

$ gem install jekyll

It might take a while to finish, but once it does you're ready to go.

Edit Site Pages

To make changes to the page or run it locally, clone this GitHub repository and make sure you have installed the dependencies above.

Then, it's a matter of editing pages and running rake tasks. Here's a rundown of possible commands (thanks to this great quickstart on Jekyll).

Preview Site

$ rake preview

BPKG: preview
BPKG: docker-preview

Builds the entire site to a local folder _site and launches a webserver to preview it.

To see the full site, point your browser to localhost:4000.

If you make any changes on any files, it will regenerate the website automatically.

Create Post

$ rake post title="Hello, World!"

BPKG: post title="Hello, World!"
BPKG: docker-post title="Hello, World!"

Creates a new post. It will create a file _posts/YYYY-MM-DD-title.md, where the date is the current, by default.

No further changes are required, the post will get automatically inserted on the site.

Create Page

$ rake page name="about"

BPKG: page name="about"
BPKG: docker-page name="about"

Creates a new page. It will create the file ./about/index.html.

$ rake page name="about.html"

BPKG: page name="about.html"
BPKG: docker-page name="about.html"

Alternative way to create a new page, on this case it will be ./about.html.

Update Style Sheets

This project uses LESS (Leaner Style Sheets) files to generate the CSS for this site. When modifying the site style sheets under the /assets directory, update the LESS files (ie: *.less). To update the CSS file after making changes to any of the LESS files, run the following command (from the root of the project):

$ lessc ./assets/themes/the-program/css/style.less ./assets/themes/the-program/css/style.css

BPKG: lessc
BPKG: docker-lessc

View Site Changes

When working on the site, sometimes it's helpful to see changes between the production copy and the output of local changes. A report of changes can be generated with the SiteDiff tool, to simplify this process a Docker service has been included with a few bpkg commands. This is a multi-step process (each step has an associated 'bpkg' command), but a single command can be used to run all the steps. Before performing these steps the local version needs to be in preview mode.

SiteDiff - Crawl Sites

The SiteDiff utility will crawl the production and the preview versions of the site prior to performing the comparison:

BPKG: site-crawl

SiteDiff - Diff Crawled Sites

After crawling the versions of the sites, SiteDiff will compare the preview against the production version and generate a change report:

BPKG: site-diff

SiteDiff - Serve Report

The generated report can be served for viewing by SiteDiff:

BPKG: site-serve

To see the report, point your browser to localhost:13080.

SiteDiff

The preceding command performs the following steps (which can be run individually):

BPKG: sitediff

Notes

• When producing content (writing pages/posts) keep in mind this useful guide. It tells how to include images, display post excerpts and highlight code snippets.
• If you plan on further customizing the blog, it's highly recommended to read this 10-minute introduction to Jekyll.
• If you change settings on the file _config.yml, automatic regeneration won't work - you'll have to run the command rake preview again.

Credits

This site uses Jekyll Bootstrap with a heavily customized version of the_program theme, originally made by Yuya Saito.

bpkg.github.io's Issues

I'm on late at all

Hi @samlikins ,

I'm to you to say Thanks! For your hard work on maintain BPKG website. During this period, my life has been turned upside down by numerous commitments.

I would like to bring two things to your attention that I hope you will enjoy:

1. The MUSH project (some similar to Cargo (Rust) but build and for BASH) - https://github.com/javanile/mush - https://mush.javanile.org/

2. A remote_theme designed to build Package-Manger website like bpkg.github.io

The benefit of a remote theme is that package-mageer-website host only the registry files and not jekyll codebase

Read more: https://talk.jekyllrb.com/t/github-pages-use-of-remote-theme/1737

Added on this I worked on this project https://github.com/javanile/package-manager

A remote theme for packager manager website (example here: https://www.javanile.org/package-manager/)

• Demo bpkg.javanile.org
• Codebase https://github.com/javanile/bpkg.javanile.org

cc @jwerle @Potherca

Host website on bpkg.sh

This page is currently available on http://bpkg.github.io/

I was wondering, how would we place it under http://bpkg.sh/ ?

GitHub pages has a guide on pointing this page to the custom domain, but I don't know how to point from the domain to this page.

Organization links still point to bpkg.io

The links on https://github.com/bpkg still point to the (hijacked?) bpkg.io.

Page Layout Full Height

The page template (with short content) fails to fill the entirety of a browser window, providing a less than glamorous look. Attempting to correct this look, I attempted to rectify it with changes in PR #65, I however missed on style rule.

Create bpkg comment account on Disqus

I just created our own account for comments on Disqus.
It means each project (and most pages) has it's own comment section. What's great is that we don't need to host no databases at all for this. Check out an example here.

This issue is merely informative: if someone wants to be a part of bpkg's Disquss comment admin team just give a shout here and I'll add you by e-mail.

It seems no way to install bpkg/github on Windows. Can you aware a user?

$ bpkg install bpkg/github

    info: Install /bpkg/github/master from remote https://raw.githubusercontent.com [https://github.com]
    info: Cloning https://github.com/bpkg/github.git to term-master
Cloning into 'term-master'...
remote: Counting objects: 95, done.
remote: Total 95 (delta 0), reused 0 (delta 0), pack-reused 95
Unpacking objects: 100% (95/95), done.
Checking connectivity... done.
    info: Performing install: `make install'
/usr/bin/install: cannot create regular file 'D:/s/devkit/local/bin': No such file or directory
make: *** [install] Error 1
rm -f /usr/local/bin/github
for cmd in json authorization common events init json request token gist; do rm -f /usr/local/bin/github-${cmd}; done
install github /usr/local/bin

Or may there is another way to run make with some tools?

site not safe

suggestion: Enforce HTTPS in github pages settings

bpkg.io hosts alternative version of site

If we go to bpkg.io, we seen some information about astrology:

It looks like the official site is bpkg.sh but bpkg.io comes up first in results. You may want to look into this, as it can cause confusion with users or possibly lead to the malicious installation of software.

Background does not cover full height on long pages

The latest changes for full-height on smaller content has caused full-height to break on longer content.

This is caused because the height is set to 100% but the page is longer than 100%.

Setting the min-height to 100% would fix this for long pages but break for short pages

The solution would be to set both height and min-height on the body but only min-height on #page:

body {
    min-height: 100%;
    height: 100%;
}

#page {
    min-height: 100%;
}

I don't have time to fix the code right now, if nobody else picks this up, I'll come back to it later.

Update information on your package's page

Hey guys, I've added all packages of our GitHub organization on the website.
You can find them at http://bpkg.sh/packages/name/

I urge you to update your project's page with more info - links, examples, tutorials, screenshots, anything. If you disagree with anywhing I wrote do change it.

To do so simply:

1. Clone this repository
2. Edit your project file under _posts. It should have a format YYYY-MM-DD-project-name.md.
3. Add whatever you want. It should be a place to advertise your project so make it beautiful ;)
4. Pull it back

Please try to make a standard appearance. If you could keep the way it is and just add more information it would be great.

P.S.: tags are free to create, although categories is undecided. For now I ask you to leave them at default.

Submitting a package doesn't work as advertised

Hi there!
I'm trying to follow the instructions to submit a package on http://www.bpkg.io/submit/
As the instructions said, I cloned, created a new branch, written the post according to the guidelines, added and committed it, but here I am stuck.

Usually I would have forked, then eventually pushed the changes, and then submitted a pull request.
The instructions say to "make a pull request with your changes to our repository. The GitHub web interface has nice green buttons for that."

So I went to look at https://github.com/bpkg/bpkg.github.io but the only green button says "Clone or download"...

How do I proceed?

Post Page Discussion with Disqus

In the process of correcting and improving several issues with the site and template, I realized that my local instance of the site had a comments section on the post pages. This was showing its head on the production site (with the line blog comments powered by Disqus), but console errors made it look like the failure was due to "Mixed Content" (ie: housing from HTTPS but requesting a resource from HTTP). I thought after fixing URLs with hard-coded protocols in the template would solve this, but it looks like I missed (at least) one. Will attempt to correct this and look harder for other explicit non-secure protocols.

What belongs in bpkg?

I'm looking for your feedback, and would welcome a dialog on what types of packages belong in bpkg. While I don't think a heavy-handed approach is ideal, some guidelines might be in order to help those coming in and to prevent "package spam".

Some thoughts:

• aliases probably don't belong in bpkg
• anything that you currently run from your ~/bin would probably be a good candidate
• bash functions that must be sourced and run in the current shell might be good candidates, but I'd want some level of scrutiny that those are being evaluated for security.

Here's an example of a function I source in my profile:

function mcd() {
    mkdir $1
    cd $1
}

And here's an example of a function I wouldn't want in my profile:

curl http://some-ad-site.com > /dev/null 2>&1