Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daguilarm/belich-documents
Documentation for Belich
https://github.com/daguilarm/belich-documents
Last synced: about 1 month ago
JSON representation
Documentation for Belich
- Host: GitHub
- URL: https://github.com/daguilarm/belich-documents
- Owner: daguilarm
- License: mit
- Created: 2019-12-06T14:20:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-05T09:47:34.000Z (over 3 years ago)
- Last Synced: 2024-05-20T16:30:00.533Z (7 months ago)
- Language: Blade
- Homepage: https://belich.dev
- Size: 4.17 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Jigsaw Docs Starter Template
This is a starter template for creating a beautiful, customizable documentation site for your project with minimal effort. You’ll only have to change a few settings and you’re ready to go.
[View a preview of the docs template.](http://jigsaw-docs-staging.tighten.co/)
## Installation
After installing Jigsaw, run the following command from your project directory:
```bash
./vendor/bin/jigsaw init docs
```
This starter template includes samples of common page types, and comes pre-configured with:
- A fully responsive navigation bar
- A sidebar navigation menu
- [Tailwind CSS](https://tailwindcss.com/), a utility CSS framework that allows you to customize your design without touching a line of CSS
- [Purgecss](https://www.purgecss.com/) to remove unused selectors from your CSS, resulting in smaller CSS files
- Syntax highlighting using [highlight.js](https://highlightjs.org/)
- A script that automatically generates a `sitemap.xml` file
- A search bar powered by [Algolia DocSearch](https://community.algolia.com/docsearch/), and instructions on how to get started with their free indexing service
- A custom 404 page
---
---
### Configuring your new site
As with all Jigsaw sites, configuration settings can be found in `config.php`; you can update the variables in that file with settings specific to your project. You can also add new configuration variables there to use across your site; take a look at the [Jigsaw documentation](http://jigsaw.tighten.co/docs/site-variables/) to learn more.
```php
// config.php
return [
'baseUrl' => 'https://my-awesome-jigsaw-site.com/',
'production' => false,
'siteName' => 'My Site',
'siteDescription' => 'Give your documentation a boost with Jigsaw.',
'docsearchApiKey' => '',
'docsearchIndexName' => '',
'navigation' => require_once('navigation.php'),
];
```
> Tip: This configuration file is also where you’ll define any "collections" (for example, a collection of the contributors to your site, or a collection of blog posts). Check out the official [Jigsaw documentation](https://jigsaw.tighten.co/docs/collections/) to learn more.
---
### Adding Content
You can write your content using a [variety of file types](http://jigsaw.tighten.co/docs/content-other-file-types/). By default, this starter template expects your content to be located in the `source/docs` folder. If you change this, be sure to update the URL references in `navigation.php`.
The first section of each content page contains a YAML header that specifies how it should be rendered. The `title` attribute is used to dynamically generate HTML `title` and OpenGraph tags for each page. The `extends` attribute defines which parent Blade layout this content file will render with (e.g. `_layouts.documentation` will render with `source/_layouts/documentation.blade.php`), and the `section` attribute defines the Blade "section" that expects this content to be placed into it.
```yaml
---
title: Navigation
description: Building a navigation menu for your site
extends: _layouts.documentation
section: content
---
```
[Read more about Jigsaw layouts.](https://jigsaw.tighten.co/docs/content-blade/)
---
### Adding Assets
Any assets that need to be compiled (such as JavaScript, Less, or Sass files) can be added to the `source/_assets/` directory, and Laravel Mix will process them when running `npm run local` or `npm run production`. The processed assets will be stored in `/source/assets/build/` (note there is no underscore on this second `assets` directory).
Then, when Jigsaw builds your site, the entire `/source/assets/` directory containing your built files (and any other directories containing static assets, such as images or fonts, that you choose to store there) will be copied to the destination build folders (`build_local`, on your local machine).
Files that don't require processing (such as images and fonts) can be added directly to `/source/assets/`.
[Read more about compiling assets in Jigsaw using Laravel Mix.](http://jigsaw.tighten.co/docs/compiling-assets/)
---
## Building Your Site
Now that you’ve edited your configuration variables and know how to customize your styles and content, let’s build the site.
```bash
# build static files with Jigsaw
./vendor/bin/jigsaw build
# compile assets with Laravel Mix
# options: dev, staging, production
npm run dev
```