Scraps Doc

Sort by - commited date

Overview

Configuration

#Getting Started Configuration is managed by Config.toml in the Scraps project. Only the title and base_url variables are required. Everything else is optional. All configuration variables used by Scraps and their default values are listed below. # The site base url base_url = "https://username.github.io/repository-name/" # The site title title = "" # The site description (optional) description = "" # The site favicon in the form of png file URL (optional) favicon = "" # The site timezone (optional, default=UTC) timezone = "UTC" # Scraps sort key choice on index page (optional, default=committed_date, choices=committed_date or linked_count) sort_key = "committed_date" # Scraps pagination on index page(optional) paginate_by = 20

Build

#CLI Usage ❯ scraps build The output will be a slugged html file as follows. ❯ tree public public ├── getting-started.html ├── scraps.html ├── index.html └── main.css

Serve

#CLI Usage ❯ scraps serve You can debug the build outputs by visiting http://127.0.0.1:1112

GitHub Pages

#Deployment Custom actions are available to deploy Scraps to Github Pages. scraps-deploy-action YAML file Prepare a yaml file under .github/workflows/ like this name: Build and deploy GH Pages on: push branches: - main paths: - 'scraps/**' jobs: build: runs-on: ubuntu-latest steps: - name: checkout uses: actions/checkout@v3 with: fetch-depth: 0 # For scraps git commited date - name: build_and_deploy uses: boykush/scraps-deploy-action@v2 env: # Target branch PAGES_BRANCH: gh-pages # Provide personal access token TOKEN: ${{ secrets.GITHUB_TOKEN }} GitHub settings Set up GitHub Pages for the repository. Build and deployment parameter as follows. Source: Deploy from a branch Branch: gh-pages

Tag

#CLI Usage You can debug tag lists using the tag command. ❯ scraps tag CLI Usage(4) https://boykush.github.io/scraps/scraps/cli-usage.html Getting Started(3) https://boykush.github.io/scraps/scraps/getting-started.html Content(2) https://boykush.github.io/scraps/scraps/content.html Deployment(1) https://boykush.github.io/scraps/scraps/deployment.html

Scraps

#Content Internal links like wiki Specifying the name of the markdown file with a notation such as [[Link]] will generate a wiki-like internal link. For example, if you have the following set of files. ❯ tree scraps scraps ├── Overview.md └── Usage.md Fill in the file name in the scraps directory in Overview.md as follows to generate the link. See [[Usage]] for detail.

Init

#CLI Usage ❯ scraps init your-scraps-project ❯ cd your-scraps-project The output result will look like this ❯ tree -a -L 1 . ├── .gitignore ├── Config.toml └── scraps