diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 6d3e5c39..31baba2a 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,6 +1,6 @@ # Development Container -This directory contains the development container configuration for the WordPress to Jekyll Exporter plugin. +This directory contains the development container configuration for the Static Site Exporter plugin. ## What's Included diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 2d29a053..c22a2fbf 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,4 +1,4 @@ -# Copilot Instructions for WordPress to Jekyll Exporter +# Copilot Instructions for Static Site Exporter ## Project Overview diff --git a/PERFORMANCE_IMPROVEMENTS.md b/PERFORMANCE_IMPROVEMENTS.md index 3e3bdef1..5074c64f 100644 --- a/PERFORMANCE_IMPROVEMENTS.md +++ b/PERFORMANCE_IMPROVEMENTS.md @@ -1,7 +1,7 @@ # Performance Optimization Summary ## Overview -This PR implements significant performance improvements to WordPress to Jekyll Exporter, addressing inefficient code patterns that caused slow exports on large WordPress sites. +This PR implements significant performance improvements to Static Site Exporter, addressing inefficient code patterns that caused slow exports on large WordPress sites. ## Key Improvements diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 46d33c7c..9b196564 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# Contributing to WordPress To Jekyll Exporter +# Contributing to Static Site Exporter -Hi there! We're thrilled that you'd like to contribute to WordPress To Jekyll Exporter. Your help is essential for keeping it great. +Hi there! We're thrilled that you'd like to contribute to Static Site Exporter. Your help is essential for keeping it great. -WordPress To Jekyll Exporter is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into WordPress To Jekyll Exporter itself. +Static Site Exporter is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into Static Site Exporter itself. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. @@ -29,7 +29,7 @@ Here are a few tips for writing *great* bug reports: ## How to suggest a feature or enhancement -If you find yourself wishing for a feature that doesn't exist in WordPress To Jekyll Exporter, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that WordPress To Jekyll Exporter has today have been added because our users saw the need. +If you find yourself wishing for a feature that doesn't exist in Static Site Exporter, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Static Site Exporter has today have been added because our users saw the need. Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you're trying to solve. @@ -37,14 +37,14 @@ Feature requests are welcome. But take a moment to find out whether your idea fi ## Minimum PHP version -Many shared hosts may use an outdated version of PHP by default. WordPress to Jekyll Export requires PHP 5.6 or greater. +Many shared hosts may use an outdated version of PHP by default. Static Site Exporter requires PHP 5.6 or greater. See [this document](required-php-version.md) for example error messages, instructions on how to determine your PHP version, and how to update to a newer version of PHP. ## Your first contribution -We'd love for you to contribute to the project. Unsure where to begin contributing to WordPress To Jekyll Exporter? You can start by looking through these "good first issue" and "help wanted" issues: +We'd love for you to contribute to the project. Unsure where to begin contributing to Static Site Exporter? You can start by looking through these "good first issue" and "help wanted" issues: * [Good first issues](https://github.com/benbalter/wordpress-to-jekyll-exporter/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two * [Help wanted issues](https://github.com/benbalter/wordpress-to-jekyll-exporter/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions diff --git a/docs/README.md b/docs/README.md index 284a01bc..fe1ba637 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -![WordPress to Jekyll Exporter logo header](https://user-images.githubusercontent.com/282759/120906741-fae1e880-c629-11eb-81df-201a3a749d75.png) +![Static Site Exporter logo header](https://user-images.githubusercontent.com/282759/120906741-fae1e880-c629-11eb-81df-201a3a749d75.png) -# WordPress to Jekyll Exporter +# Static Site Exporter One-click WordPress plugin that converts all posts, pages, taxonomies, metadata, and settings to Markdown and YAML which can be dropped into Jekyll (or Hugo or any other Markdown and YAML based site engine). diff --git a/docs/developing-locally.md b/docs/developing-locally.md index 985914d6..3017c7b2 100644 --- a/docs/developing-locally.md +++ b/docs/developing-locally.md @@ -21,7 +21,7 @@ See [.devcontainer/README.md](../.devcontainer/README.md) for more details. ### Option 2: Manual Setup -#### Prerequisites +### Prerequisites 1. `sudo apt-get update` 1. `sudo apt-get install composer` @@ -34,7 +34,7 @@ See [.devcontainer/README.md](../.devcontainer/README.md) for more details. 1. `sudo apt-get install php-pear` 1. `sudo pear install PHP_CodeSniffer` -#### Bootstrap & Setup +### Bootstrap & Setup 1. `git clone https://github.com/benbalter/wordpress-to-jekyll-exporter` 2. `cd wordpress-to-jekyll-exporter` diff --git a/docs/examples/optimization-examples.php b/docs/examples/optimization-examples.php index 8e89b3c9..88c4f7bb 100644 --- a/docs/examples/optimization-examples.php +++ b/docs/examples/optimization-examples.php @@ -155,7 +155,7 @@ function test_jekyll_export_config() { } echo '
';
-    echo "WordPress to Jekyll Exporter Configuration Test\n";
+    echo "Static Site Exporter Configuration Test\n";
     echo "==============================================\n\n";
     
     // Check post types
diff --git a/docs/performance-optimizations.md b/docs/performance-optimizations.md
index 42f5c5ec..1dcfa543 100644
--- a/docs/performance-optimizations.md
+++ b/docs/performance-optimizations.md
@@ -1,6 +1,6 @@
 # Performance Optimizations
 
-This document describes the performance optimizations implemented in WordPress to Jekyll Exporter to improve export speed and reduce resource usage, especially for large WordPress sites.
+This document describes the performance optimizations implemented in Static Site Exporter to improve export speed and reduce resource usage, especially for large WordPress sites.
 
 ## Overview
 
diff --git a/docs/required-php-version.md b/docs/required-php-version.md
index 9034cb6c..52e6a7c0 100644
--- a/docs/required-php-version.md
+++ b/docs/required-php-version.md
@@ -1,6 +1,6 @@
 ## Minimum required PHP version
 
-Many shared hosts may use an outdated version of PHP by default. **WordPress to Jekyll Export requires PHP 5.6 or greater.**
+Many shared hosts may use an outdated version of PHP by default. **Static Site Exporter requires PHP 5.6 or greater.**
 
 If you get an error message that looks like `unexpected T_STRING`, `unexpected '['` or `expecting T_CONSTANT_ENCAPSED_STRING`, you need to update your PHP version. In a shared hosting environment, you should be able to change the version of PHP used by simply toggling the setting in the host's control panel.
 
diff --git a/readme.txt b/readme.txt
index cfdaa992..037ace25 100644
--- a/readme.txt
+++ b/readme.txt
@@ -195,7 +195,7 @@ See [.devcontainer/README.md](https://ben.balter.com/wordpress-to-jekyll-exporte
 
 = Option 2: Manual Setup =
 
-= # Prerequisites =
+= Prerequisites =
 
 1. `sudo apt-get update`
 1. `sudo apt-get install composer`
@@ -208,7 +208,7 @@ See [.devcontainer/README.md](https://ben.balter.com/wordpress-to-jekyll-exporte
 1. `sudo apt-get install php-pear`
 1. `sudo pear install PHP_CodeSniffer`
 
-= # Bootstrap & Setup =
+= Bootstrap & Setup =
 
 1. `git clone https://github.com/benbalter/wordpress-to-jekyll-exporter`
 2. `cd wordpress-to-jekyll-exporter`
@@ -227,7 +227,7 @@ See [.devcontainer/README.md](https://ben.balter.com/wordpress-to-jekyll-exporte
 
 === Performance Optimizations ===
 
-This document describes the performance optimizations implemented in WordPress to Jekyll Exporter to improve export speed and reduce resource usage, especially for large WordPress sites.
+This document describes the performance optimizations implemented in Static Site Exporter to improve export speed and reduce resource usage, especially for large WordPress sites.
 
 == Overview ==
 
@@ -599,7 +599,7 @@ Include in your report:
 
 == Minimum required PHP version ==
 
-Many shared hosts may use an outdated version of PHP by default. **WordPress to Jekyll Export requires PHP 5.6 or greater.**
+Many shared hosts may use an outdated version of PHP by default. **Static Site Exporter requires PHP 5.6 or greater.**
 
 If you get an error message that looks like `unexpected T_STRING`, `unexpected '['` or `expecting T_CONSTANT_ENCAPSED_STRING`, you need to update your PHP version. In a shared hosting environment, you should be able to change the version of PHP used by simply toggling the setting in the host's control panel.
 
diff --git a/script/build-readme b/script/build-readme
index af7944be..b389ec1b 100755
--- a/script/build-readme
+++ b/script/build-readme
@@ -13,6 +13,7 @@ docs = Dir["./docs/*"]
 
 docs.each do |file|
   next if exclude.include?(File.basename(file,".md"))
+  next if File.directory?(file)
   output << "\n\n"
   output << File.open(file).read
 end