jekyllup

Site | NPM Module | GitHub Repo

jekyllup is the official npm module of JekyllUp, a free theme database for Jekyll websites.

🌐 JekyllUp Works in Node AND browser environments

Yes, this module works in both Node and browser environments, including compatibility with Webpack and Browserify!

🦄 Features

• Theme database for Jekyll websites.

🔑 Getting an API key

You can use so much of jekyllup for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by signing up for a JekyllUp account.

📦 Install JekyllUp

Option 1: Install via npm

Install with npm if you plan to use jekyllup in a Node project or in the browser.

npm install jekyllup

If you plan to use jekyllup in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.

const jekyllup = new (require('jekyllup'))({
  // Not required, but having one removes limits (get your key at https://jekyllup.com).
  apiKey: 'api_test_key'
});

Option 2: Install via CDN

Install with CDN if you plan to use JekyllUp only in a browser environment.

<script src="https://cdn.jsdelivr.net/npm/jekyllup@latest/dist/index.min.js"></script>
<script type="text/javascript">
  var jekyllup = new JekyllUp({
    // Not required, but having one removes limits (get your key at https://jekyllup.com).
    apiKey: 'api_test_Key'
  });
</script>

Option 3: Use without installation

You can use jekyllup in a variety of ways that require no installation, such as curl in terminal/shell.

# Standard
curl -X POST https://api.jekyllup.com

⚡️ Usage

jekyllup.run(options)

jekyllup.run(options);

📘 Using JekyllUp

After you have followed the install step, you can start using jekyllup to enhance your project.

For a more in-depth documentation of this library and the JekyllUp service, please visit the official JekyllUp website.

📝 What Can JekyllUp do?

JekyllUp is a free theme database for Jekyll websites

🗨️ Final Words

If you are still having difficulty, we would love for you to post a question to the JekyllUp issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

📚 Projects Using this Library

• ITW Creative Works
• Somiibo
• Slapform
• StudyMonkey
• DashQR
• Replyify
• SoundGrail
• Trusteroo

Ask us to have your project listed! :)