Giter Club home page Giter Club logo

skf's Introduction

Installation

With make

cd skf
sudo make install

Archlinux

yaourt skf-framework

Usage

You may find instructions on how to use skf here.

Contributions

You may read the TODO.md file if you want to contribute to this project.

  • If you are only writing a plugin, just go ahead and code.
  • If you want to contribute to the main code (Which is less than 500 lines), please contact me before doing so.
  • If you found a bug and know how to patch it, go ahead and let me know (use a patch file).

For now, skf has no contributions.

skf's People

Contributors

moebiuseye avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

skf's Issues

Securing parameters

Hi !

You should use -- where applicable. For example when you do

mkdir -p "$VAR"

you should instead do

mkdir -p -- "$VAR"

Problem with the explanation for --init option

People tend to use the --init option with an argument, directly in the $HOME directory.
This isn't how it's supposed to work.

TODO : Clear things up in the readme and add a warning if people are using --init in their home directory.

Shebang

Hi !

Why do you use

#!/bin/bash

instead of

#!/usr/bin/env bash

as shebang ?

Using printf instead of echo

Hi !

You should use printf instead of echo in your scripts because it’s a lot safer than echo and allows a better control of output.

Cannot install from ArchLinux AUR

Installing throws the following error:

$ LANG=en_GB.UTF8 pacaur -S skf-framework

:: Package(s) skf-framework not found in repositories, trying AUR...
:: resolving dependencies...
:: looking for inter-conflicts...

AUR Packages  (1) skf-framework-89.43094a3-1  

:: Proceed with installation? [Y/n] Y
:: Retrieving package(s)...
:: skf-framework build files are up-to-date -- skipping
:: Checking skf-framework integrity...
==> Making package: skf-framework 89.43094a3-1 (Tue 30 Aug 21:04:39 CEST 2016)
==> Retrieving sources...
  -> Updating skf git repo...
Fetching origin
==> Validating source files with md5sums...
    skf ... Skipped
:: Building skf-framework package(s)...
==> Making package: skf-framework 99.886346e-1 (Tue 30 Aug 21:04:40 CEST 2016)
==> Checking runtime dependencies...
==> Checking buildtime dependencies...
==> Retrieving sources...
  -> Updating skf git repo...
Fetching origin
==> Validating source files with md5sums...
    skf ... Skipped
==> Extracting sources...
  -> Creating working copy of skf git repo...
Switched to a new branch 'makepkg'
==> Starting pkgver()...
==> Starting build()...
 DSTDIR = /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework 
==> Entering fakeroot environment...
==> Starting package()...
mkdir -p /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework/usr/bin
install -m 755 ./skf ./skf.gen ./skf.init -t /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework/usr/bin/
mkdir -p /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework/usr/share/skf
cp -R ./share/* -t /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework/usr/share/skf/
find /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework/usr/share/skf -type f -exec chmod 644 {} \;
find /home/arch/.cache/pacaur/skf-framework/pkg/skf-framework/usr/share/skf -type d -exec chmod 755 {} \;
==> Tidying install...
  -> Removing libtool files...
  -> Purging unwanted files...
  -> Removing static library files...
  -> Stripping unneeded symbols from binaries and libraries...
  -> Compressing man and info pages...
==> Checking for packaging issue...
==> Creating package "skf-framework"...
  -> Generating .PKGINFO file...
  -> Generating .BUILDINFO file...
  -> Generating .MTREE file...
  -> Compressing package...
==> Leaving fakeroot environment.
==> Finished making: skf-framework 99.886346e-1 (Tue 30 Aug 21:04:41 CEST 2016)
==> Cleaning up...
:: Installing skf-framework package(s)...
:: skf-framework package(s) failed to install. Check .SRCINFO for mismatching data with PKGBUILD.

Add alternative (competitor)

Hi, I have created another static site generator (bash/mksh) some time ago for my website which is inspired by the suckless philosophy, I really hope that you can add it as alternatives.

https://github.com/pickfire/sssg

It seems like you did some nice job handling there.

Clarify the function of export_base_url in the documentation

It would help people starting to use the skf if the documentation mentioned that the export_base_url can accept a value which includes the domain, like:

export_base_url=https://user.github.io/

or with the domain and the path to the skf site's folder

export_base_url=https://user.github.io/my_skf_blog

or with just the path to the skf site's folder(Including leading slash)

export_base_url=/my_skf_blog/

or, if left with no value at all it will also work. I noticed this because I was attempting to test locally and it redirected me to a nonexistent page at my github blog. Including a few more examples like the ones above would help users who might want to present their site on different domains(Similarly, static sites are especially easy to deploy as Tor Hidden Services or i2p eepSites, which I personally think are the most fun way to blog.) or test things on a LAN before putting them online.

New plugin git

I'll be coding an experimental plugin that generates a page giving information about git repositories contained within the directory.

For instance, here is the result of a tree -a command (some lines were removed):

.
|-- left.md
|-- other_repository
|   `-- .git
|       |-- branches
.       .
.       .
.       .
|       `-- refs
|           |-- heads
|           `-- tags
|-- repository
|   `-- .git
|       |-- branches
.       .
.       .
.       .
|       `-- refs
|           |-- heads
|           `-- tags
`-- .skfrc

The result will be a directory with an index.md file displaying left.md in the left, and rss link in the menu, and -- in the main area -- the list of repositories (titles as links) and the description (if available). These links will lead to http://domain/.../repository.md and http://domain/.../other_repository.md. These files contain various informations about the repository. (List of commits, current branch, download link, etc) <- If you want a feature, just ask, and I'll look into it.

The variable $compression_method in the .skfrc can be used to either zip(value=zip), gzip(vlue=gzip), or just copy(value=copy)

Be aware that the use of "copy" as a value for compression_method will open a security issue. Do not use it with repositories that you do not trust.

Also, using this plugin while in watch mode is highly advised against. (You will be compressing repositories every 10 seconds if you are tweaking with a file.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.