💡 Correct Javadocs name, title

[AyhamAl-Ali]

Suggestion

Skript Javadocs should be named Skript $VERSION$ e.g. Skript 2.7.0
https://docs.skriptlang.org/javadocs/

Name

Webpage Title

Why?

cuz we cool

Other

No response

Agreement

• I have read the guidelines above and affirm I am following them with this suggestion.

[MihirKohli]

Can you assign me this issue?

[Moderocky]

While we're here, are you aware you can change the styling of the javadocs template so it doesn't look like it arrived here in a time machine from 2003?

If you are interested in making it not look the way it does, let me know and I can show you how to build it with a special stylesheet.

Below is a simple example with the colours changed; you could do the same in Skript's colour scheme

You are, of course, able to make much larger changes to the styling but remember that the layout and the files are procedurally-generated, so you must work with what you are given.

[MihirKohli]

While we're here, are you aware you can change the styling of the javadocs template so it doesn't look like it arrived here in a time machine from 2003?

If you are interested in making it not look the way it does, let me know and I can show you how to build it with a special stylesheet.

Below is a simple example with the colours changed; you could do the same in Skript's colour scheme

You are, of course, able to make much larger changes to the styling but remember that the layout and the files are procedurally-generated, so you must work with what you are given.

Is it possible to make changes in all the instance at once? Making all pages have common header & favicon?

[Moderocky]

Is it possible to make changes in all the instance at once? Making all pages have common header & favicon?

Possibly, Maven comes with a built-in plugin for manipulating javadocs but Skript uses gradle and I don't know what the equivalent is for that. You might have to google it :)

[MihirKohli]

Updated Changes required for Homepage
SkriptLang/skript-docs#50

[MihirKohli]

[MihirKohli]

Is it possible to make changes in all the instance at once? Making all pages have common header & favicon?

Possibly, Maven comes with a built-in plugin for manipulating javadocs but Skript uses gradle and I don't know what the equivalent is for that. You might have to google it :)

Btw i am interested in building as you have mentioned above

[MihirKohli]

How to add favicon couldn't find any reference @AyhamAl-Ali ?

[AyhamAl-Ali]

How to add favicon couldn't find any reference @AyhamAl-Ali ?

Based on my quick research (with help of ChatGPT as well), you can do that using gradle

// Define a variable to store the path to your favicon image
def faviconPath = 'resources/favicon.ico'

// Configure the Javadoc task
javadoc {
    // Include the favicon in the Javadoc output
    options {
        // Add the following line to include the favicon
        headContent = "<link rel='icon' type='image/x-icon' href='$faviconPath'/>"
    }
}

for the title, current gradle properties file already have an option for it only set to the version, it should be "Skript" + version

[MihirKohli]

javadoc {
	source = sourceSets.main.allJava
	classpath = configurations.compileClasspath
	options.encoding = 'UTF-8'
	// currently our javadoc has a lot of errors, so we need to suppress the linter
	options.addStringOption('Xdoclint:none', '-quiet')
}

task releaseJavadoc(type: Javadoc) {
	title = project.name + ' ' + project.property('version')
	source = sourceSets.main.allJava
	classpath = configurations.compileClasspath
	options.encoding = 'UTF-8'
	// currently our javadoc has a lot of errors, so we need to suppress the linter
	options.addStringOption('Xdoclint:none', '-quiet')
}

i have tried various ways still favicon doesn't show up on viewing html
Thank you if you can help me?

[AyhamAl-Ali]

javadoc {
	source = sourceSets.main.allJava
	classpath = configurations.compileClasspath
	options.encoding = 'UTF-8'
	// currently our javadoc has a lot of errors, so we need to suppress the linter
	options.addStringOption('Xdoclint:none', '-quiet')
}

task releaseJavadoc(type: Javadoc) {
	title = project.name + ' ' + project.property('version')
	source = sourceSets.main.allJava
	classpath = configurations.compileClasspath
	options.encoding = 'UTF-8'
	// currently our javadoc has a lot of errors, so we need to suppress the linter
	options.addStringOption('Xdoclint:none', '-quiet')
}

i have tried various ways still favicon doesn't show up on viewing html Thank you if you can help me?

Sounds like you will need more help with that which contradicts the idea behind PRs. I would suggest you create a PR for the titles with the correct way (you sent above) and leave the favicon for others or maybe we will push the changes on your PR

[MihirKohli]

#6045