Skip to content

Core functionality of your website.

License

Notifications You must be signed in to change notification settings

annaesvensson/yellow-core

Repository files navigation

Deutsch   English   Svenska

Core 0.9.12

Core functionality of your website.

Screenshot

How to install an extension

Download ZIP file and copy it into your system/extensions folder. Learn more about extensions.

How to edit a website on your computer

You can change everything in the file manager on your computer. The content folder contains the content files of the website. You can edit your website here. The media folder contains the media files of the website. You can store your images and files here. The system folder contains the system files of the website. You can find configuration files and the log file here. Learn more about the API for developers.

You can edit your website in your favorite text editor. Open the file content/1-home/page.md. At the top of the page you can change Title and other page settings. Below you can change text and images. Text formatting with Markdown is supported. HTML is also supported. Learn more about text formatting.

How to use the command line

You can execute commands at the command line. This allows you, for example, to start a web server and generate a static website. The available commands depend on extensions installed. Open a terminal window. Go to your installation folder, where the file yellow.php is. Type php yellow.php to show available commands.

The following commands are available:

php yellow.php about = Show extensions, requires update extension
php yellow.php check = Find broken links, requires check extension
php yellow.php clean = Clean static website, requires generate extension
php yellow.php generate = Generate static website, requires generate extension
php yellow.php install = Install extensions, requires update extension
php yellow.php publish = Publish extensions, requires publish extension
php yellow.php serve = Start web server, requires serve extension
php yellow.php traffic = Create traffic analytics, requires traffic extension
php yellow.php uninstall = Uninstall extensions, requires update extension
php yellow.php update = Update website, requires update extension
php yellow.php user = Create user accounts, requires edit extension

How to add a page

Add a new file to the content folder.

How to remove a page

Remove the file from the content folder.

How to hide a page

Set Status: unlisted in the page settings at the top of a page. The page is no longer visible in navigation, sitemap and search results. You can choose between different status values, to control who can see and access a page.

How to redirect a page

Set Redirect in the page settings at the top of a page. The page is redirected to another page or URL. You can continue to edit the page in the web browser and on your computer.

How to customise a page

Set Layout and Theme in the page settings at the top of a page. The HTML code of a page can be customised in the layout file. The CSS code of a page can be customised in the theme file. Have a look at the existing files and customise them. Your changes will not be overwritten when the website is updated. Learn more about layouts and themes.

Examples

Content file with normal page:

---
Title: Normal page
---
This is an example page.

Content file with unlisted page:

---
Title: Unlisted page
Status: unlisted
---
This page is not visible in navigation, sitemap and search results.

Content file with redirection:

---
Title: Redirect page
Redirect: https://datenstrom.se/yellow/
---
This page is redirected to another page.

Content file for error page:

---
Title: File not found
Layout: error
---
The requested file was not found. Oh no...

Layout file for default page:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php echo $this->yellow->page->getContentHtml() ?>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Settings

The following settings can be configured in file system/extensions/yellow-system.ini:

Sitename = name of the website
Author = name of the webmaster
Email = email of the webmaster
Language = default language, e.g. en
Layout = default layout
Theme = default theme
Parser = default content parser
Status = default page status, supported status values
CoreServerUrl = URL of the website, auto for automatic detection
CoreTimezone = timezone of the website, supported timezones
CoreContentExtension = file extension for content
CoreContentDefaultFile = content file for folders
CoreContentErrorFile = content file for error page
CoreLanguageFile = file with language settings
CoreUserFile = file with user settings
CoreExtensionFile = file with extension settings
CoreWebsiteFile = log file of the website
CoreAssetLocation = location for virtually mapped system files
CoreMediaLocation = location for media files
CoreDownloadLocation = location for downloads
CoreImageLocation = location for images
CoreThumbnailLocation = location for thumbnails
CoreMultiLanguageMode = enable multi language mode, 1 or 0
CoreDebugMode = enable debug mode, 0 to 3

The following settings can be configured at the top of a page:

Title = page title
TitleContent = page title shown in content
TitleNavigation = page title shown in navigation
TitleHeader = page title shown in web browser
TitleSlug = page title used for saving the page
Description = page description
Author = page author(s), comma separated
Email = email of page author
Language = page language, e.g. en
Layout = page layout
LayoutNew = page layout for creating a new page
Theme = page theme
Parser = page content parser
Status = page status, supported status values
Redirect = redirect to another page or URL
Image = page image
ImageAlt = description of the page image
Modified = page modification date, YYYY-MM-DD format
Published = page publication date, YYYY-MM-DD format
Tag = page tag(s) for categorisation, comma separated
Generate = option(s) for generating a static website, comma separated
Comment = option(s) for showing comments, comma separated

The following page status values are supported:

public = page is a normal page
private = page is not visible, user needs to enter password, requires private extension
draft = page is not visible, user needs to log in, requires draft extension
unlisted = page is not visible, but can be accessed with the correct link
shared = page is not visible, but can be included in other pages

The following files can be customised:

content/1-home/page.md = content file for home page
content/shared/page-error-404.md = content file for error page
system/layouts/default.html = layout file for default page
system/layouts/error.html = layout file for error page
system/layouts/header.html = layout file for default HTML header
system/layouts/footer.html = layout file for default HTML footer
system/layouts/navigation.html = layout file for default HTML navigation
system/layouts/pagination.html = layout file for default HTML pagination

Acknowledgements

This extension was previously maintained by Mark Seuffert and David Fehrmann. Thank you for the good work.

Developer

Anna Svensson. Get help.