getpublii/publii

The most intuitive Static Site CMS designed for SEO-optimized and privacy-focused websites.

Publii - Static CMS for privacy-focused, SEO-optimized websites.

Publii is a desktop-based CMS for Windows, Mac and Linux that makes creating static websites fast and hassle-free, even for beginners.

Current version: 0.45.2 (build 16609)

Why Publii?

Unlike static-site generators that are often unwieldy and difficult to use, Publii provides an easy-to-understand UI much like server-based CMSs such as WordPress or Joomla!, where users can create posts and other site content, and style their site using a variety of built-in themes and options. Users can enjoy the benefits of a super-fast and secure static website, with all the convenience that a CMS provides.

What makes Publii even more unique is that the app runs locally on your desktop rather than on the site's server. Available for Windows, Mac, Linux once the app has been installed you can create a site in minutes, even without internet access; since Publii is a desktop app you can create, update and modify your site offline, then upload the site changes to your server at the click of a button. Publii supports multiple upload options, including standard HTTP/HTTPS servers, Netlify, Amazon S3, GitHub Pages and Google Cloud or SFTP.

Download

Publii is available for Mac, Windows, and Linux and can be downloaded from our website:

Download Publii (.exe, .dmg, .deb, .rpm, .AppImage)

Developing

If you want to build newest version of Publii or contribute to the Publii code, please read about app build process.

Getting Started

You can learn more about getting started in our User documentation or Developer documentation. If you have any questions or suggestions, or just need some help with using Publii, you can visit our Community Hub or follow us on Twitter

Learn More

• User docs
• Developer docs
• Wiki
• Issues
• Community forum

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Copyright (c) 2022 TidyCustoms. General Public License v3.0, read LICENSE for details.

publii's Issues

Github library update

[email protected]: 'github' has been renamed to '@octokit/rest' (https://git.io/vNB11)

Docs: https://octokit.github.io/rest.js/

Improve layout of the tag selector under post editor

As it looks bad in some cases (e.g. while adding new tags to the empty field).

Support for GitLab Pages

Needs bigger research.

ref. https://github.com/jdalrymple/node-gitlab
ref. https://docs.gitlab.com/ee/api/
ref. https://docs.gitlab.com/ee/user/project/pages/

Support for custom controls under theme settings

Needs bigger research:

• if it is possible to load custom component in the fly (potential solution: https://github.com/alexjoverm/v-runtime-template ),
• custom component should load option value, parse it and then display its state,
• before theme settings save, the component should return the new state,
• how we can store custom component in the theme JSON file?
• how to store custom component value in the theme settings?
• check if it is possible to use single component files (with CSS / JS)

Wrong canonical link when the pagination phrase is changed to the custom one.

When we set the custom name of the pagination phrase, the canonical link is not affected by this change and still show the default phrase (pages).

You should remember to apply this fix to rel attribute (rel="next" rel="prev"), the same to AMP page.

advanced.config.json file for power users

It will be a file placed in the app config directory, where advanced users can specify additional options i.e. order used in the posts list used for links popup (ref. https://publii.ticksy.com/ticket/1412503)

Thanks to this we can save simple App UI and power users will be able to get additional functions.

We can also consider simple editor for these settings under tools (like browsers have their flags internal pages).

Options should be stored as long, unique names e.g. editor.link_popup.posts_dropdown.ordering

Other useful options:

jsonld.output_data.use_modification_date_as_publish_date - for replacing publication date with modification date value.
server_configuration.global_ssh_key - for use unique keys on shared websites: https://publii.ticksy.com/ticket/1673090

Display post source code after clicking script in the WYSIWYG editor

as in the title ;)

Better layout of the WYSIWYG editor under theme settings

Add full width, padding and bigger min-height

AMP - add amp-consent support

ref. https://www.ampproject.org/docs/reference/components/amp-consent

{{hasCustomExcerpt}} flag

This flag will allow theme developers to detect when user uses custom excerpt content.

In many cases this kind of excerpt should be wrapped into <div></div> instead of <p></p>.

Improve regenerate thumbnails process

Random empty "Icon?" files causes regenerate thumbnails process crash.

Unified styling of the WYSIWYG editor in theme settings

• new design of the source code editor
• unified design of the link popup

Field to specify destination editor of customElements

This feature will allow theme developers to display some customElements only under theme settings / post editor.

The default destination will be set to post editor.

ref. https://publii.ticksy.com/ticket/1605187

Fix filtering of the ignored asset files

Currently only the assets in the root assets catalog are filtered.

ref. https://publii.ticksy.com/ticket/1615392

Link target option for the external links in menus

ref. https://publii.ticksy.com/ticket/1611551

Variables %tagname, %sitename and %authorname are not working on tag/author pages

Issue with pagination styling in the Square theme

There is no margin between the buttons.

@bobmitro - please check if this issue do not appear on other themes.

Apply the custom pagination phrase on the author's page

Changing the pagination phrase to your own, actually affects only the index and tags pages, it should also cover the author's page.

You should remember that this change affects:

• canonical link
• rel attribute
• link to the AMP page

This change should be applied also on the AMP page.

Favicon creation

Publii should generate all necessary favicons like realfavicongenerator.net and prepare necessary metatags for them.

ref. https://publii.ticksy.com/ticket/1559488

Change S3 ACL for files.publii.json to "authenticated-read"

I noticed that the code that uploads the files.publii.json file to S3 uses the public-read ACL. Since this file is only used by Publii to determine what files it needs to update when deploying, and Publii should be authenticated with AWS, could the canned ACL be changed to authenticated-read? According to the canned ACL documentation, this should allow Publii to still access the file but prevent the file from being publicly accessible.

Detection of non-existing catalogs

ref. https://publii.ticksy.com/ticket/1559155

• During preview - notification about non-existing catalog used as a preview directory
• In app settings - detect if selected catalog not exists

Sitemap helper uses always "page" for pagination links

It should use custom phrase if user specifies it.

Link to Github repository in the app menu

Allow multiple menu positions for one menu

ToDO:

• multiple select for menu position
• change method of saving menus (use semicolon as separator)
• support for the new menu structure in the renderer
• helper used for the menu display should have an option which allows developers to display only first level of the menu

Controls for select post/author/tag available for the theme settings

Analyze how we can create an API for this kind of fields and make it a valuable part of the Theme Options API.

Important: Add an option to filter draft, featured, hidden posts from the posts select control.

Change of keyboard shortcuts for Search and Replace

Use:

• Ctrl + H (Windows)
• CONTROL + H (macOs)

And add description under the editor:

media/files directory can be not created under some conditions

Netlify API upgrade

Current library is deprecated: https://github.com/netlify/node-client

Netlify uses now Open API: https://github.com/netlify/open-api/

New library is available: https://github.com/netlify/js-client

Support for FontAwesome in the post editor

The settings of the WYSIWYG should be modified to allow use of icons.
“extended_valid_elements” to “i[*]”
FontAwesome markup is deleted automatically by TinyMCE currently.

ref. https://publii.ticksy.com/ticket/1612549

Change behaviour of the "Save as draft" button in the post editor

It should not close the editor.

ref. https://publii.ticksy.com/ticket/1420739/

GDPR - let users delete the Required Group

In some cases, the user may need to use GDPR cookie popup with no checkboxes (e.g., he does not use cookies, but due to an obligation to provide information he has to inform his visitors about this fact).

Log viewer - select of the first option crash the application

It is caused by not handling of the empty value during file loading.

ref. https://publii.ticksy.com/ticket/1614938/

Refactor of the server settings view

Few changes:

• Use notifications instead of alerts
• Mark invalid fields
• Use v-model instead of ref

Better custom post options

• More field types
• Documentation
• Dependencies between fields

Better sort for site names

With use of localCompare.

UI for post/tag/author ordering on lists

Over the list we should add the following information Ordered by: title (descending) Reset, where title (descending) is a select field and Reset restores the ordering to default state.

• options to set default ordering of posts/tags/authors under app settings.

Tooltips with item ID for tags and authors listing

The post listing in the app have tooltips with post IDs. The same tooltips should be added for tags and authors views.

Allow for multiple languages websites

Add options for multiple languages websites and native hreflang support for the sitemap.

File manager - add file selection under post editor

To allow users select and link files which was uploaded in the file manager.

RSS feeds uses site name instead of displayName

Disable responsive images URL generation for external images in posts

Currently Publii generates responsive URLs for external images what prevents these images from load.

Password protected posts

Needs deeper analyze.

ref. https://github.com/matteobrusa/Password-protection-for-static-pages
ref. https://publii.ticksy.com/ticket/1591753#comment-7951141

It should works everywhere exceptin Github Pages. But users should be informed about necessary configuration (disable directory listings etc.).

Text file editor in file manager

For some types of files we can allow users to edit them directly in the file manager.

Images preview popup in file manager

To avoid redirect to the native app.

Use ASAR in application builds

Needs bigger research.

It will allow us to optimize the installation process as it creates one big file from all small files included in the node_modules package.

Remove automatic add of http:// prefix in external menu items

This feature blocks adding custom URLs like mailto:, tel:, in-app links etc.

Video control in the post editor

ref. https://publii.ticksy.com/ticket/1591753

Option to not render in menu links to empty tags

ref. https://publii.ticksy.com/ticket/1545900

Note: implementation of this feature will need a bigger changes in the menu renderer. I do not think that current use cases for this feature as worth of it.

I prepared multiple tags which will be used in the future. I also added them already to my menu structure. In the Publii menu editor such an entry is rendered stroke through and red with a tooltip saying "Linked item is not rendered (empty tag/author page), not exists or is trashed". This is all good. 

Now it would be fantastic if it actually wouldn't render that menu item at all if such a tag is empty. Use case: I prepare everything for my non-tech-savvy parents so they wouldn't have to care about the menu.

Optimize application start time

Needs bigger research.

ref. electron/electron#5672

Consider lazy load at start to show splash screen as soon as possible.

New layout for website switcher