Skip to content

Custom theme to be used with your Writerside Documentation site.

License

Notifications You must be signed in to change notification settings

devOS-Sanity-Edition/Cuprite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Cuprite

Cuprite is a rounded corners theme designed for Writerside documentation. The point is to make it look simplistic and as clean as with some other visual hints and animation to adminitions and cards.

If you want to see how Cuprite looks in a live environment, you can view the Yiski documentation.

Note

We do not support Algolia search as we don't have a key, so the theme is likely to look off with Search functions. Sorry about that. This may change in the future though.

Usage

Important

This is meant to be used with Writerside 2024.1 EAP as of the time of writing, older versions of Writerside will not be supported!

Open your Writerside project and go to your Writerside/cfg/buildprofiles.xml, and allow Custom CSS by adding to your Build Profile's Variables, and adding a Link Color and Primary Color to your Variables too, like so

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <variables></variables>
    <build-profile instance="docs">
        <variables>
            <primary-color>#F75D62</primary-color>
            <link-color>#F75D62</link-color>
            <custom-css>custom.css</custom-css>
        </variables>
        </footer>
    </build-profile>

</buildprofiles>

Now under Writerside/cfg, make a new folder called static, and then a file named custom.css. Writerside will now pull that Custom CSS file.

Now go to https://github.com/devOS-Sanity-Edition/Cuprite/blob/main/Cuprite.css and download the CSS file. Drop that CSS file into the same static directory.

On the top, add this if you want all of the CSS tweaks Cuprite makes

@import "Cuprite.css";

After that, add the following to your Custom CSS file

:root {
    /* REPLACE 247, 92, 98 WITH YOUR BRANDING'S COLOR IN RGB */
    --actual-primary-color: 247, 93, 98;
}

We would've supported loading the CSS file using a link to the GitHub repository, however, CORS happened. :C

corsmoment

Individual tweaks will be available at a later date.

Screenshots

image image image image image image image image image image image

Videos

Arc_0LWw56574s.mp4
Arc_UXSKlaAANe.mp4
Arc_dOcSgoPasM.mp4

License

This project is licensed under the MIT License.

Releases

No releases published

Packages

No packages published

Languages