Download the PHP package jigsawboxes/simple-docs-template without Composer
On this page you can find all versions of the php package jigsawboxes/simple-docs-template. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jigsawboxes/simple-docs-template
More information about jigsawboxes/simple-docs-template
Files in jigsawboxes/simple-docs-template
Package simple-docs-template
Short Description Documentation starter template for Jigsaw static site generator by Tighten
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package simple-docs-template
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.
Installation
After installing Jigsaw, run the following command from your project directory:
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, a utility CSS framework that allows you to customize your design without touching a line of CSS
- Purgecss to remove unused selectors from your CSS, resulting in smaller CSS files
- Syntax highlighting using highlight.js
- A script that automatically generates a
sitemap.xmlfile - A search bar powered by Algolia 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 to learn more.
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 to learn more.
Adding Content
You can write your content using a variety of 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.
Read more about Jigsaw layouts.
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 dev or npm run prod. 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.
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.
