diff --git a/docs/Guide/Site Settings.md b/docs/Guide/Site Settings.md new file mode 100644 index 0000000..da07a45 --- /dev/null +++ b/docs/Guide/Site Settings.md @@ -0,0 +1,51 @@ +# Website Settings + +
+ +## Opening the Settings + +To access the settings page for a website, log in to SiteWriter, open the Sites page, find the website in the list, and click the Settings button. + +## Settings Cards + +The website settings are broken up into different cards. Each card contains a different category of settings. To save the settings, scroll all the way to the bottom of the page and press Save. + +### Site Info + +Card with input boxes labled Title and URL + +The Site Info settings card allows you to set the website title and URL. The title is shown in several places on the website. + +

+ +### Theme + +This card allows you to choose a theme for your website. Some themes have multiple sub-themes, called color styles. Click the Preview button on a theme or color style to see your website in that theme. + +Theme selection card + +### Company Info + +Card with text boxes labeled Name, Phone, Address, and Email + +The Company Info card allows you to set the company name, phone number, address, and email address. This information will be placed on the website in a suitable location, such as the bottom of the page or near a contact form. + +### Social Links + +If your company has public pages on various social media platforms, place links to those pages here. Website visitors will be shown icons corresponding to those platforms, and can click on them to be taken to your social media page. For example, if you have a Facebook page and YouTube channel, visitors will see a and a on your site, and can click on them to go to your Facebook page and YouTube channel respectively. + +### Analytics + +Card with option to enable or disable built-in analytics + +If you do not wish to track users with the built-in SiteWriter analytics, you can disable that here. This does not affect third-party services, such as Google Analytics or Matomo. + +### Extra Code + +Card with text box for adding extra HTML code to the site header + +If you need to add code for third-party services, you can copy and paste it into this box. It will be inserted in every page on your website. This is useful for enabling services such as Google Analytics, or inserting extra metadata tags. If you aren't familiar with HTML code, be careful, as you can easily make your website appear broken to visitors using this tool. If something does break, try removing the contents of the Extra code text box, saving the settings, and reloading the website. + +### Site Footer Links + +This card allows you to add web links to the bottom of your website. The title is shown to visitors, and they will be taken to the link when they click the title. \ No newline at end of file diff --git a/docs/Self-Hosting and Development/Installing.md b/docs/Self-Hosting and Development/Installing.md new file mode 100644 index 0000000..5b93bf0 --- /dev/null +++ b/docs/Self-Hosting and Development/Installing.md @@ -0,0 +1,9 @@ +# Installing + +0. Install AccountHub +1. Copy `settings.template.php` to `settings.php` +2. Import `database.sql` into your database server +3. Edit `settings.php` and fill in your DB info +4. Set the URL of the install +7. Run `composer install` (or `composer.phar install`) to install dependency libraries +9. From a web browser, visit `http://apps/url` (or whatever your setup is). If you did everything right, you should see a login screen. \ No newline at end of file diff --git a/docs/System Requirements.md b/docs/Self-Hosting and Development/System Requirements.md similarity index 98% rename from docs/System Requirements.md rename to docs/Self-Hosting and Development/System Requirements.md index 015fdd3..7fff24f 100644 --- a/docs/System Requirements.md +++ b/docs/Self-Hosting and Development/System Requirements.md @@ -14,8 +14,6 @@ The Business Apps are very lightweight on server resources. The minimum support * Ubuntu * Debian * PHP - * 7.0 - * 7.1 * 7.2 * Database * MySQL 5.7+ diff --git a/docs/Theme Development.md b/docs/Self-Hosting and Development/Theme Development.md similarity index 100% rename from docs/Theme Development.md rename to docs/Self-Hosting and Development/Theme Development.md diff --git a/docs/images/docs-icon.svg b/docs/images/docs-icon.svg deleted file mode 100644 index 2912202..0000000 --- a/docs/images/docs-icon.svg +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/logo.svg b/docs/images/logo.svg deleted file mode 100644 index 816e640..0000000 --- a/docs/images/logo.svg +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - diff --git a/docs/images/screenshots/settings_analytics.png b/docs/images/screenshots/settings_analytics.png new file mode 100644 index 0000000..b023c5d Binary files /dev/null and b/docs/images/screenshots/settings_analytics.png differ diff --git a/docs/images/screenshots/settings_companyinfo.png b/docs/images/screenshots/settings_companyinfo.png new file mode 100644 index 0000000..1399635 Binary files /dev/null and b/docs/images/screenshots/settings_companyinfo.png differ diff --git a/docs/images/screenshots/settings_extracode.png b/docs/images/screenshots/settings_extracode.png new file mode 100644 index 0000000..29961af Binary files /dev/null and b/docs/images/screenshots/settings_extracode.png differ diff --git a/docs/images/screenshots/settings_siteinfo.png b/docs/images/screenshots/settings_siteinfo.png new file mode 100644 index 0000000..abc213f Binary files /dev/null and b/docs/images/screenshots/settings_siteinfo.png differ diff --git a/docs/images/screenshots/settings_theme.png b/docs/images/screenshots/settings_theme.png new file mode 100644 index 0000000..9ac3d7c Binary files /dev/null and b/docs/images/screenshots/settings_theme.png differ diff --git a/docs/index.md b/docs/index.md index 3494765..ab8acc1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,6 @@ -# SiteWriter - SiteWriter is an easy-to-use website design system. -## Features +# Features * __Simple Editor__ * Create awesome websites with zero coding or design experience. diff --git a/docs/media.css b/docs/media.css new file mode 100644 index 0000000..f48540e --- /dev/null +++ b/docs/media.css @@ -0,0 +1,25 @@ +.md-content img { + box-shadow: 0 1px 4px rgba(0,0,0,0.4); + margin: 10px; + float: right; +} + +.md-content img.no-shadow { + box-shadow: none; +} + +.md-content .aspect-16x9 { + position: relative; + width: 100%; + height: 0; + padding-bottom: 56.25%; + box-shadow: 0 1px 10px rgba(0,0,0,0.5); +} + +.md-content .aspect-16x9 iframe { + position: absolute; + width: 100%; + height: 100%; + left: 0; + top: 0; +} diff --git a/mkdocs.yml b/mkdocs.yml index 72be84e..c7f4ae3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,18 +1,23 @@ site_name: SiteWriter Docs theme: name: 'material' - logo: 'images/logo.svg' - favicon: 'images/docs-icon.svg' + logo: 'https://static.netsyms.net/images/products/sitewriter/logo.svg' + favicon: 'https://static.netsyms.net/images/netsyms/documentation/docs-icon.svg' + font: false feature: tabs: false palette: primary: 'light-blue' accent: 'light-blue' extra_javascript: - - track.js + - 'https://static.netsyms.net/fontawesome/5.3.1/js/all.min.js' + - 'https://docs.netsyms.com/track.js' +extra_css: + - 'https://docs.netsyms.com/font.css' + - 'https://docs.netsyms.com/media.css' site_author: Netsyms Technologies repo_name: 'Business/SiteWriter' repo_url: 'https://source.netsyms.com/Business/SiteWriter' -copyright: Copyright © 2018 Netsyms Technologies. All rights reserved. Copying is allowed for instructional purposes (such as creating an internal user help document) as long as credit is given and this copyright notice is included. For other purposes, or if you are selling a product containing copied material, please contact us for permission. +copyright:
Creative Commons License
Copyright © 2018 Netsyms Technologies. Some rights reserved.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. markdown_extensions: - codehilite