* sharding item and sharding parameter split by =, multiple sharding items and sharding parameters split by comma, just like map. * Sharding item start from zero, cannot equal to great than sharding total count. * For example: * 0=a,1=b,2=c *
* * @param shardingItemParameters mapper of sharding items and sharding parameters * @return job configuration builder */ public Builder shardingItemParameters(final String shardingItemParameters) { if (null != shardingItemParameters) { this.shardingItemParameters = shardingItemParameters; } return this; } /** * Set job parameter. * * @param jobParameter job parameter * * @return job configuration builder */ public Builder jobParameter(final String jobParameter) { if (null != jobParameter) { this.jobParameter = jobParameter; } return this; } /** * Set enable or disable monitor execution. * ** For short interval job, it is better to disable monitor execution to improve performance. * It can't guarantee repeated data fetch and can't failover if disable monitor execution, please keep idempotence in job. * For long interval job, it is better to enable monitor execution to guarantee fetch data exactly once. *
* * @param monitorExecution monitor job execution status * @return ElasticJob configuration builder */ public Builder monitorExecution(final boolean monitorExecution) { this.monitorExecution = monitorExecution; return this; } /** * Set enable failover. * ** Only for `monitorExecution` enabled. *
* * @param failover enable or disable failover * @return job configuration builder */ public Builder failover(final boolean failover) { this.failover = failover; return this; } /** * Set enable misfire. * * @param misfire enable or disable misfire * @return job configuration builder */ public Builder misfire(final boolean misfire) { this.misfire = misfire; return this; } /** * Set max tolerate time different seconds between job server and registry center. * ** ElasticJob will throw exception if exceed max tolerate time different seconds. * -1 means do not check. *
* * @param maxTimeDiffSeconds max tolerate time different seconds between job server and registry center * @return ElasticJob configuration builder */ public Builder maxTimeDiffSeconds(final int maxTimeDiffSeconds) { this.maxTimeDiffSeconds = maxTimeDiffSeconds; return this; } /** * Set reconcile interval minutes for job sharding status. * ** Monitor the status of the job server at regular intervals, and resharding if incorrect. *
* * @param reconcileIntervalMinutes reconcile interval minutes for job sharding status * @return ElasticJob configuration builder */ public Builder reconcileIntervalMinutes(final int reconcileIntervalMinutes) { this.reconcileIntervalMinutes = reconcileIntervalMinutes; return this; } /** * Set job sharding strategy type. * ** Default for {@code AverageAllocationJobShardingStrategy}. *
* * @param jobShardingStrategyType job sharding strategy type * @return ElasticJob configuration builder */ public Builder jobShardingStrategyType(final String jobShardingStrategyType) { if (null != jobShardingStrategyType) { this.jobShardingStrategyType = jobShardingStrategyType; } return this; } /** * Set job executor thread pool size provider type. * * @param jobExecutorThreadPoolSizeProviderType job executor thread pool size provider type * @return job configuration builder */ public Builder jobExecutorThreadPoolSizeProviderType(final String jobExecutorThreadPoolSizeProviderType) { this.jobExecutorThreadPoolSizeProviderType = jobExecutorThreadPoolSizeProviderType; return this; } /** * Set job error handler type. * * @param jobErrorHandlerType job error handler type * @return job configuration builder */ public Builder jobErrorHandlerType(final String jobErrorHandlerType) { this.jobErrorHandlerType = jobErrorHandlerType; return this; } /** * Set job listener types. * * @param jobListenerTypes job listener types * @return ElasticJob configuration builder */ public Builder jobListenerTypes(final String... jobListenerTypes) { this.jobListenerTypes.addAll(Arrays.asList(jobListenerTypes)); return this; } /** * Add extra configurations. * * @param extraConfig job extra configuration * @return job configuration builder */ public Builder addExtraConfigurations(final JobExtraConfiguration extraConfig) { extraConfigurations.add(extraConfig); return this; } /** * Set job description. * * @param description job description * @return job configuration builder */ public Builder description(final String description) { if (null != description) { this.description = description; } return this; } /** * Set property. * * @param key property key * @param value property value * @return job configuration builder */ public Builder setProperty(final String key, final String value) { props.setProperty(key, value); return this; } /** * Set whether disable job when start. * ** Using in job deploy, start job together after deploy. *
* * @param disabled whether disable job when start * @return ElasticJob configuration builder */ public Builder disabled(final boolean disabled) { this.disabled = disabled; return this; } /** * Set whether overwrite local configuration to registry center when job startup. * ** If overwrite enabled, every startup will use local configuration. *
* * @param overwrite whether overwrite local configuration to registry center when job startup * @return ElasticJob configuration builder */ public Builder overwrite(final boolean overwrite) { this.overwrite = overwrite; return this; } /** * Set label. * * @param label label * @return ElasticJob configuration builder */ public Builder label(final String label) { this.label = label; return this; } /** * Set static sharding. * * @param staticSharding static sharding * @return ElasticJob configuration builder */ public Builder staticSharding(final boolean staticSharding) { this.staticSharding = staticSharding; return this; } /** * Build ElasticJob configuration. * * @return ElasticJob configuration */ public final JobConfiguration build() { Preconditions.checkArgument(!Strings.isNullOrEmpty(jobName), "jobName can not be empty."); Preconditions.checkArgument(shardingTotalCount > 0, "shardingTotalCount should larger than zero."); return new JobConfiguration(jobName, cron, timeZone, shardingTotalCount, shardingItemParameters, jobParameter, monitorExecution, failover, misfire, maxTimeDiffSeconds, reconcileIntervalMinutes, jobShardingStrategyType, jobExecutorThreadPoolSizeProviderType, jobErrorHandlerType, jobListenerTypes, extraConfigurations, description, props, disabled, overwrite, label, staticSharding); } } } ================================================ FILE: api/src/main/java/org/apache/shardingsphere/elasticjob/api/JobExtraConfiguration.java ================================================ /* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.shardingsphere.elasticjob.api; /** * Job extra configuration. */ public interface JobExtraConfiguration { } ================================================ FILE: api/src/main/java/org/apache/shardingsphere/elasticjob/api/JobExtraConfigurationFactory.java ================================================ /* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.shardingsphere.elasticjob.api; import java.util.Optional; /** * Job extra configuration factory. */ public interface JobExtraConfigurationFactory { /** * Get job extra configuration. * * @return job extra configuration */ Optional一旦该节点被删除将会触发重新选举
重新选举的过程中一切主节点相关的操作都将阻塞 | | election\latch | 否 | 主节点选举的分布式锁
为 curator 的分布式锁使用 | | sharding\necessary | 否 | 是否需要重新分片的标记
如果分片总数变化，或作业服务器节点上下线或启用/禁用，以及主节点选举，会触发设置重分片标记
作业在下次执行时使用主节点重新分片，且中间不会被打断
作业执行时不会触发分片 | | sharding\processing | 是 | 主节点在分片时持有的节点
如果有此节点，所有的作业执行都将阻塞，直至分片结束
主节点分片结束或主节点崩溃会删除此临时节点 | | failover\items\分片项 | 否 | 一旦有作业崩溃，则会向此节点记录
当有空闲作业服务器时，会从此节点抓取需失效转移的作业项 | | failover\items\latch | 否 | 分配失效转移分片项时占用的分布式锁
为 curator 的分布式锁使用 | ### 流程图 #### 作业启动  #### 作业执行  ================================================ FILE: docs/content/features/elastic.en.md ================================================ +++ pre = "3.2. " title = "Elastic Schedule" weight = 2 chapter = true +++ Elastic schedule is the most important feature in ElasticJob, which acts as a job processing system that enables the horizontal scaling of jobs by sharding, it's also the origin of the project name "ElasticJob". ## Sharding A concept in ElasticJob to split the job, enabling the job to be executed in distributed environment, where every single server only executes one of the slice that is assigned to it. ElasticJob is aware of the number of servers in an almost-real-time manner, with the increment/decrement number of the servers, it re-assigns the job slices to the distributed servers, maximizing the efficiency as the increment of resources. To execute the job in distributed servers, a job will be divided into multiple individual job items, one or some of which will be executed by the distributed servers. For example, if a job is divided into 4 slices, and there are two servers to execute the job, then each server is assigned 2 slices, undertaking 50% of the workload, as follows.  ### Sharding Item ElasticJob doesn't directly provide the abilities to process the data, instead, it assigns the sharding items to the job servers, where the developers should process the sharding items and their business logic themselves. The sharding item is numeric type, in the range of [0, size(slices) - 1]. ### Customized sharding options Customized sharding options can build a relationship with the sharding items, converting the sharding items' numbers to more readable business codes. For example, to horizontally split the databases according to the regions, database A stores data from Beijing, database B stores data from Shanghai and database C stores data from Guangzhou. If we configure only by the sharding items' numbers, the developers need the knowledge that 0 represents Beijing, 1 represents Shanghai and 2 represents Guangzhou. Customized sharding options make the codes more readable, if we have customized options `0=Beijing,1=Shanghai,2=Guangzhou`, we can simply use `Beijing`, `Shanghai`, `Guangzhou` in the codes. ## Maximize the usage of resources ElasticJob provides a flexible way to maximize the throughput of the jobs. When new job server joins, ElasticJob will be aware of it from the registry, and will re-shard in the next scheduling process, the new server will undertake some of the job slices, as follows.  Configuring a larger number of sharding items than the number of servers, or better, a multiplier of the number of servers, makes it more reasonably for the job to leverage the resources, and assign the sharding items dynamically. For example, we have 10 sharding items and there are 3 servers, the number of sharding items are server A = 0,1,2,9; server B = 3,4,5; server C = 6,7,8. If the server C is down, then server A = 0,1,2,3,4 and B = 5,6,7,8,9, maximizing the throughput without losing any sharding item. ## High Availability When a server is down when executing a sharding item, the registry is also aware of that, and the sharding item will be transferred to another living server, thus achieve the goal of high availability. The unfinished job from a crashed server will be transferred and executed continuously, as follows.  Setting the total number of sharding items to 1 and more than 1 servers to execute the jobs makes the job run in the mode of `1` master and `n` slaves. Once the servers that are executing jobs are down, the idle servers will take over the jobs and execute them in the next scheduling, or better, if the failover option is enabled, the idle servers can take over the failed jobs immediately. ## Implementation Principle ElasticJob does not have a job scheduling center node, but the programs based on the deployment job framework trigger the scheduling when the corresponding time point is reached. The registration center is only used for job registration and monitoring information storage. The main job node is only used to handle functions such as sharding and cleaning. ### Elastic Distributed Implementation - The first server went online to trigger the main server election. Once the main server goes offline, the election is triggered again, and the election process is blocked. Only when the main server election is completed, other tasks will be performed. - When a job server goes online, it will automatically register the server information to the registry, and automatically update the server status when it goes offline. - The re-sharding flag will be updated when the master node is elected, the server goes offline, and the total number of shards changes. - When a scheduled task is triggered, if it needs to be sharded again, it will be sharded by the main server. The sharding process is blocked, and the task can be executed after the sharding ends. If the main server goes offline during the sharding process, the master server will be elected first and then perform sharding. - From the previous description, in order to maintain the stability of the job runtime, only the sharding status will be marked during the running process, and the sharding will not be re-sharded. Sharding can only occur before the next task is triggered. - Each execution of sharding will sort instances by server IP to ensure that the sharding result will not produce large fluctuations. - Realize the failover function, actively grab the unallocated shards after a certain server is executed, and actively search for available servers to perform tasks after a certain server goes offline. ### Registry Data Structure The registration center creates a job name node under the defined namespace to distinguish different jobs, so once a job is created, the job name cannot be modified. If the name is modified, it will be regarded as a new job. There are 5 data sub-nodes under the job name node, namely config, instances, sharding, servers and leader. ### config node Job configuration information, stored in YAML format. ### instances node Job running instance information, the child node is the primary key of the current job running instance. The primary key of the job running instance is composed of the IP address and PID of the job running server. The primary keys of the job running instance are all ephemeral nodes, which are registered when the job instance is online and automatically cleaned up when the job instance is offline. The registry monitors the changes of these nodes to coordinate the sharding and high availability of distributed jobs. You can write TRIGGER in the job running instance node to indicate that the instance will be executed once immediately. ### sharding node Job sharding information. The child node is the sharding item sequence number, starting from zero and ending with the total number of shards minus one. The child node of the sharding item sequence number stores detailed information. The child node under each shard is used to control and record the running status of the shard. Node details description： | Child node name | Ephemeral node | Description | |-----------------|:---------------|:-----------------------------------------------------------------------------------------------------------------------------------| | instance | NO | The primary key of the job running instance that executes the shard | | running | YES | The running state of the shard item.
Only valid when monitorExecution is configured | | failover | YES | If the shard item is assigned to another job server by failover, this node value records the job server IP that executes the shard | | misfire | NO | Whether to restart the missed task | | disabled | NO | Whether to disable this shard | ### servers node Job server information, the child node is the IP address of the job server. You can write DISABLED in the IP address node to indicate that the server is disabled. Under the new cloud-native architecture, the servers node is greatly weakened, only including controlling whether the server can be disabled. In order to achieve the core of the job more purely, the server function may be deleted in the future, and the ability to control whether the server is disabled should be delegated to the automated deployment system. ### leader node The master node information of the job server is divided into three sub-nodes: election, sharding and failover. They are used for master node election, sharding and failover processing respectively. The leader node is an internally used node. If you are not interested in the principle of the job framework, you don't need to pay attention to this node. | Child node name | Ephemeral node | Description | |---------------------------|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | election\instance | YES | The IP address of the master node server.
Once the node is deleted, a re-election will be triggered.
All operations related to the master node will be blocked during the re-election process. | | election\latch | NO | Distributed locks elected by the master node
Used for distributed locks of curator | | sharding\necessary | NO | The flag for re-sharding. If the total number of shards changes, or the job server node goes online or offline or enabled/disabled, as well as the master node election, the re-sharded flag will be triggered. The master node is re-sharded without being interrupted in the middle
The sharding will not be triggered when the job is executed | | sharding\processing | YES | The node held by the master node during sharding.
If there is this node, all job execution will be blocked until the sharding ends.
The ephemeral node will be deleted when the master node sharding is over or the master node crashes | | failover\items\shard item | NO | Once a job crashes, it will record to this node.
When there is an idle job server, it will grab the job items that need to failover from this node | | failover\items\latch | NO | Distributed locks used when allocating failover shard items.
Used by curator distributed locks | ================================================ FILE: docs/content/features/failover.cn.md ================================================ +++ pre = "3.4. " title = "失效转移" weight = 4 chapter = true +++ ElasticJob 不会在本次执行过程中进行重新分片，而是等待下次调度之前才开启重新分片流程。 当作业执行过程中服务器宕机，失效转移允许将该次未完成的任务在另一作业节点上补偿执行。 ## 概念 失效转移是当前执行作业的临时补偿执行机制，在下次作业运行时，会通过重分片对当前作业分配进行调整。 举例说明，若作业以每小时为间隔执行，每次执行耗时 30 分钟。如下如图所示。  图中表示作业分别于 12:00，13:00 和 14:00 执行。图中显示的当前时间点为 13:00 的作业执行中。 如果作业的其中一个分片服务器在 13:10 的时候宕机，那么剩余的 20 分钟应该处理的业务未得到执行，并且需要在 14:00 时才能再次开始执行下一次作业。 也就是说，在不开启失效转移的情况下，位于该分片的作业有 50 分钟空档期。如下如图所示。  在开启失效转移功能之后，ElasticJob 的其他服务器能够在感知到宕机的作业服务器之后，补偿执行该分片作业。如下图所示。  在资源充足的情况下，作业仍然能够在 13:30 完成执行。 ## 执行机制 当作业执行节点宕机时，会触发失效转移流程。ElasticJob 根据触发时的分布式作业执行的不同状况来决定失效转移的执行时机。 ### 通知执行 当其他服务器感知到有失效转移的作业需要处理时，且该作业服务器已经完成了本次任务，则会实时的拉取待失效转移的分片项，并开始补偿执行。 也称为实时执行。 ### 问询执行 作业服务在本次任务执行结束后，会向注册中心问询待执行的失效转移分片项，如果有，则开始补偿执行。 也称为异步执行。 ## 适用场景 开启失效转移功能，ElasticJob 会监控作业每一分片的执行状态，并将其写入注册中心，供其他节点感知。 在一次运行耗时较长且间隔较长的作业场景，失效转移是提升作业运行实时性的有效手段； 对于间隔较短的作业，会产生大量与注册中心的网络通信，对集群的性能产生影响。 而且间隔较短的作业并未见得关注单次作业的实时性，可以通过下次作业执行的重分片使所有的分片正确执行，因此不建议短间隔作业开启失效转移。 另外需要注意的是，作业本身的幂等性，是保证失效转移正确性的前提。 ================================================ FILE: docs/content/features/failover.en.md ================================================ +++ pre = "3.4. " title = "Failover" weight = 4 chapter = true +++ ElasticJob will not re-shard during this execution, but wait for the next scheduling before starting the re-sharding process. When the server is down during job execution, failover allows the unfinished task to be compensated and executed on another job node. ## Concept Failover is a temporary compensation execution mechanism for the currently executed job. When the next job is run, the current job allocation will be adjusted through resharding. For example, if the job is executed at an hourly interval, each execution will take 30 minutes. As shown below.  The figure shows that the jobs are executed at 12:00, 13:00 and 14:00 respectively. The current time point shown in the figure is the job execution at 13:00. If one of the shard servers of the job goes down at 13:10, the remaining 20 minutes of the business that should be processed are not executed, and the next job can only be executed at 14:00. In other words, if failover is not turned on, there is a 50-minute idle period in this shard. As shown below.  After the failover is enabled, other ElasticJob servers can compensate for the execution of the sharding job after sensing the down job server. As shown below.  With sufficient resources, the job can still be executed completely at 13:30. ## Execution mechanism When the job execution node goes down, the failover process will be triggered. ElasticJob determines the execution timing of the failover according to the different conditions of the distributed job execution when it is triggered。 ### Notification execution When other servers perceive that a failover job needs to be processed, and the job server has completed this task, it will pull the items to be failed over in real time and start compensation execution. Also called real-time execution. ### Enquiry execution After the execution of this task, the job service will inquire about the failover items to be executed from the registry, and if there are any, the compensation execution will start. Also called asynchronous execution. ## Scenarios: With the failover enabled, ElasticJob will monitor the execution status of each shard of the job and write it to the registry for other nodes to perceive. In a job scenario that takes a long time to run and has a long interval, failover is an effective means to improve the real-time operation of the job; For short-interval jobs, a large number of network communications with the registry will be generated, which will affect the performance of the cluster; Moreover, short-interval jobs do not necessarily pay attention to the real-time performance of a single job. You can use the re-shard of the next job execution to make all the items execute correctly. Therefore, it is not recommended to enable failover for short-interval jobs. Another thing to note is that the idempotence of the job itself is a prerequisite to ensure the correctness of failover. ================================================ FILE: docs/content/features/job-type.cn.md ================================================ +++ pre = "3.6. " title = "作业开放生态" weight = 6 chapter = true +++ 灵活定制化作业是 ElasticJob 3.x 版本的最重要设计变革。 新版本基于 Apache ShardingSphere 可插拔架构的设计理念，打造了全新作业 API。 意在使开发者能够更加便捷且相互隔离的方式拓展作业类型，打造 ElasticJob 作业的生态圈。 ElasticJob 提供了对作业的弹性伸缩、分布式治理等功能的同时，并未限定作业的类型。 它通过灵活的作业 API，将作业解耦为作业接口和执行器接口。 用户可以定制化全新的作业类型，诸如脚本执行、HTTP 服务执行（3.0.0-beta 提供）、大数据类作业、文件类作业等。 目前 ElasticJob 内置了简单作业、数据流作业和脚本执行作业，并且完全开放了扩展接口，开发者可以通过 SPI 的方式引入新的作业类型，并且可以便捷的回馈至社区。 ## 作业接口 ElasticJob 的作业可划分为基于 class 类型和基于 type 类型两种。 Class 类型的作业由开发者直接使用，需要由开发者实现该作业接口实现业务逻辑。典型代表：Simple 类型、Dataflow 类型。 Type 类型的作业只需提供类型名称即可，开发者无需实现该作业接口，而是通过外置配置的方式使用。典型代表：Script 类型、HTTP 类型。 ## 执行器接口 用于执行用户定义的作业接口，通过 Java 的 SPI 机制织入 ElasticJob生态。 ================================================ FILE: docs/content/features/job-type.en.md ================================================ +++ pre = "3.6. " title = "Job Open Ecosystem" weight = 6 chapter = true +++ Flexible customized jobs is the most important design change in ElasticJob 3.x . The new version is based on the design concept of the Apache ShardingSphere pluggable architecture, and the new Job API was created. It is intended to enable developers to expand the types of jobs in a more convenient and isolated way, and create an ecosystem of ElasticJob jobs. While ElasticJob provides functions such as elastic scaling and distributed management of jobs, it does not limit the types of jobs. It uses flexible job APIs to decouple jobs into job interfaces and actuator interfaces. Users can customize new job types, such as script execution, HTTP service execution, big data jobs, file jobs, etc. At present, ElasticJob has built-in simple jobs, data flow jobs, and script execution jobs, and has completely opened up the extension interface. Developers can introduce new job types through SPI, and they can easily give back to the community. ## Job interface ElasticJob jobs can be divided into two types: `Class-based Jobs` and `Type-based Jobs`. `Class-based Jobs` are directly used by developers, who need to implement the job interface to realize business logic. Typical representatives: Simple type, Dataflow type. `Type-based Jobs` only need to provide the type name, developers do not need to implement the job interface, but use it through external configuration. Typical representatives: Script type, HTTP type (Since 3.0.0-beta). ## Actuator interface It is used to execute user-defined job interfaces and weave into the ElasticJob ecosystem through Java's SPI mechanism. ================================================ FILE: docs/content/features/misfire.cn.md ================================================ +++ pre = "3.5. " title = "错过任务重执行" weight = 5 chapter = true +++ ElasticJob 不允许作业在同一时间内叠加执行。 当作业的执行时长超过其运行间隔，错过任务重执行能够保证作业在完成上次的任务后继续执行逾期的作业。 ## 概念 错过任务重执行功能可以使逾期未执行的作业在之前作业执行完成之后立即执行。 举例说明，若作业以每小时为间隔执行，每次执行耗时 30 分钟。如下如图所示。  图中表示作业分别于 12:00，13:00 和 14:00 执行。图中显示的当前时间点为 13:00 的作业执行中。 如果 12：00 开始执行的作业在 13:10 才执行完毕，那么本该由 13:00 触发的作业则错过了触发时间，需要等待至 14:00 的下次作业触发。 如下如图所示。  在开启错过任务重执行功能之后，ElasticJob 将会在上次作业执行完毕后，立刻触发执行错过的作业。如下图所示。  在 13：00 和 14:00 之间错过的作业将会重新执行。 ## 适用场景 在一次运行耗时较长且间隔较长的作业场景，错过任务重执行是提升作业运行实时性的有效手段； 对于未见得关注单次作业的实时性的短间隔的作业来说，开启错过任务重执行并无必要。 ================================================ FILE: docs/content/features/misfire.en.md ================================================ +++ pre = "3.5. " title = "Misfire" weight = 5 chapter = true +++ ElasticJob does not allow jobs to be executed at the same time. When the execution time of a job exceeds its running interval, re-executing the missed task can ensure that the job continues to execute the overdue job after completing the last task. ## Concept The misfire function enables the overdue tasks to be executed immediately after the completion of the previous tasks. For example, if the job is executed at an hourly interval, each execution will take 30 minutes. As shown below.  The figure shows that the jobs are executed at 12:00, 13:00 and 14:00 respectively. The current time point shown in the figure is the job execution at 13:00. If the job executed at 12:00 is finished at 13:10, then the job that should have been triggered by 13:00 missed the trigger time and needs to wait until the next job trigger at 14:00. As shown below.  After the misfire is enabled, ElasticJob will trigger the execution of the missed job immediately after the last job is executed. As shown below.  Missed jobs between 13:00 and 14:00 will be executed again. ## Scenarios In a job scenario that takes a long time to run and has a long interval, misfire is an effective means to improve the real-time operation of the job; For short-interval jobs that do not necessarily pay attention to the real-time performance of a single job, it is not necessary to turn on the misfire to re-execute. ================================================ FILE: docs/content/features/schedule-model.cn.md ================================================ +++ pre = "3.1. " title = "调度模型" weight = 1 chapter = true +++ ElasticJob 是面向进程内的线程级调度框架。通过它，作业能够透明化的与业务应用系统相结合。 它能够方便的与 Spring 、Dubbo 等 Java 框架配合使用，在作业中可自由使用 Spring 注入的 Bean，如数据源连接池、Dubbo 远程服务等，更加方便的贴合业务开发。 ================================================ FILE: docs/content/features/schedule-model.en.md ================================================ +++ pre = "3.1. " title = "Schedule Model" weight = 1 chapter = true +++ ElasticJob is a thread-level scheduling framework for in-process. Through it, Job can be transparently combined with business application systems. It can be easily used in conjunction with Java frameworks such as Spring and Dubbo. Spring DI (Dependency Injection) Beans can be freely used in Job, such as data source connection pool and Dubbo remote service, etc., which is more convenient for business development. ================================================ FILE: docs/content/overview/_index.cn.md ================================================ +++ pre = "1. " title = "概览" weight = 1 chapter = true +++ [](https://github.com/apache/shardingsphere-elasticjob/releases) [](https://github.com/apache/shardingsphere-elasticjob/stargazers) [](https://github.com/apache/shardingsphere-elasticjob/fork) [](https://github.com/apache/shardingsphere-elasticjob/watchers) [](https://starchart.cc/apache/shardingsphere-elasticjob) ElasticJob 通过弹性调度、资源管控、以及作业治理的功能，打造一个适用于互联网场景的分布式调度解决方案，并通过开放的架构设计，提供多元化的作业生态。 它的各个产品使用统一的作业 API，开发者仅需一次开发，即可随意部署。 ElasticJob 已于 2020 年 5 月 28 日成为 [Apache ShardingSphere](https://shardingsphere.apache.org/) 的子项目。 欢迎通过[邮件列表](mailto:dev@shardingsphere.apache.org)参与讨论。 [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://github.com/apache/shardingsphere-elasticjob/releases) [](https://maven-badges.herokuapp.com/maven-central/org.apache.shardingsphere.elasticjob/elasticjob) [](https://travis-ci.org/apache/shardingsphere-elasticjob) [](https://coveralls.io/github/apache/shardingsphere-elasticjob?branch=master) ## 简介 使用 ElasticJob 能够让开发工程师不再担心任务的线性吞吐量提升等非功能需求，使他们能够更加专注于面向业务编码设计； 同时，它也能够解放运维工程师，使他们不必再担心任务的可用性和相关管理需求，只通过轻松的增加服务节点即可达到自动化运维的目的。 ElasticJob 定位为轻量级无中心化解决方案，使用 jar 的形式提供分布式任务的协调服务。  ## 功能列表 - 弹性调度 - 支持任务在分布式场景下的分片和高可用 - 能够水平扩展任务的吞吐量和执行效率 - 任务处理能力随资源配备弹性伸缩 - 资源分配 - 在适合的时间将适合的资源分配给任务并使其生效 - 相同任务聚合至相同的执行器统一处理 - 动态调配追加资源至新分配的任务 - 作业治理 - 失效转移 - 错过作业重新执行 - 自诊断修复 - 作业依赖(TODO) - 基于有向无环图（DAG）的作业间依赖 - 基于有向无环图（DAG）的作业分片间依赖 - 作业开放生态 - 可扩展的作业类型统一接口 - 丰富的作业类型库，如数据流、脚本、HTTP、文件、大数据等 - 易于对接业务作业，能够与 Spring 依赖注入无缝整合 - 可视化管控端 - 作业管控端 - 作业执行历史数据追踪 - 注册中心管理 ## 环境要求 ### Java 请使用 Java 8 及其以上版本。 ### Maven 请使用 Maven 3.5.0 及其以上版本。 ### ZooKeeper 请使用 ZooKeeper 3.6.0 及其以上版本。[详情参见](https://zookeeper.apache.org/) ================================================ FILE: docs/content/overview/_index.en.md ================================================ +++ pre = "1. " title = "Overview" weight = 1 chapter = true +++ [](https://github.com/apache/shardingsphere-elasticjob/releases) [](https://github.com/apache/shardingsphere-elasticjob/stargazers) [](https://github.com/apache/shardingsphere-elasticjob/fork) [](https://github.com/apache/shardingsphere-elasticjob/watchers) [](https://starchart.cc/apache/shardingsphere-elasticjob) Through the functions of flexible scheduling, resource management and job management, it creates a distributed scheduling solution suitable for Internet scenarios, and provides a diversified job ecosystem through open architecture design. It uses a unified job API for each project. Developers only need code one time and can deploy at will. ElasticJob became an [Apache ShardingSphere](https://shardingsphere.apache.org/) Sub project on May 28 2020. Welcome communicate with community via [mail list](mailto:dev@shardingsphere.apache.org). [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://github.com/apache/shardingsphere-elasticjob/releases) [](https://maven-badges.herokuapp.com/maven-central/org.apache.shardingsphere.elasticjob/elasticjob) [](https://travis-ci.org/apache/shardingsphere-elasticjob) [](https://coveralls.io/github/apache/shardingsphere-elasticjob?branch=master) ## Introduction Using ElasticJob can make developers no longer worry about the non-functional requirements such as jobs scale out, so that they can focus more on business coding; At the same time, it can release operators too, so that they do not have to worry about jobs high availability and management, and can automatic operation by simply adding servers. ElasticJob is a lightweight, decentralized solution that provides distributed task sharding services.  ## Features - Elastic Schedule - Support job sharding and high availability in distributed system - Scale out for throughput and efficiency improvement - Job processing capacity is flexible and scalable with the allocation of resources - Resource Assign - Execute job on suitable time and assigned resources - Aggregation same job to same job executor - Append resources to newly assigned jobs dynamically - Job Governance - Failover - Misfired - Self diagnose and recover when distribute environment unstable - Job Dependency (TODO) - DAG based job dependency - DAG based job item dependency - Job Open Ecosystem - Unify job api for extension - Support rich job type lib, such as dataflow, script, HTTP, file, big data - Focus business SDK, can work with Spring IOC - Admin Console - Job administration - Job event trace query - Registry center management ## Environment Required ### Java Java 8 or above required. ### Maven Maven 3.5.0 or above required. ### ZooKeeper ZooKeeper 3.6.0 or above required. [See details](https://zookeeper.apache.org/) ================================================ FILE: docs/content/powered-by/_index.cn.md ================================================ +++ pre = "7. " title = "采用公司" weight = 7 chapter = true +++ ## 登记 欢迎采用了 ElasticJob 的公司在此登记，您的支持是我们最大的动力。 请按`公司名` + `首页` + `应用案例（可选）` 的格式在[此处](https://github.com/apache/shardingsphere-elasticjob/issues/254)登记。 ## 谁在使用 ElasticJob? 共计 83 家公司。 ### 电子商务 ### 金融行业 ### 数字化与云服务 ### 出行 ### 物流 ### 房地产 ### 互联网教育 ### 互联网文娱 ### 新闻资讯 ### 通信科技 ### 物联网 ### 软件开发及服务 ### 医疗健康 ### 零售业 ### 人工智能
================================================
FILE: docs/content/powered-by/_index.en.md
================================================
+++
pre = "7. "
title = "Powered By"
weight = 7
chapter = true
+++
## Register
Welcome to register by company + homepage + use case(optional), your support is important to us.
Please register [here](https://github.com/apache/shardingsphere-elasticjob/issues/254) with `company` + `homepage` + `use case(optional)`.
## Who are using ElasticJob?
Total: 83 companies.
### E-commerce
- DangDang
- Three Squirrels
- BESSKY
- HAI ZOL
- Xiu
- homedo
- AVIC B2B ONLINE TRADING OLATRORM
- GShopper
- ChunBo
- HuiNong
- DaZong
- YangSC
- DG-Mail
- Nex Poster
- JD
- Best Pay
- WX XISHANG BANK
- ppdai
- YinSheng E-Pay
- ZhongAn Tech
- JinCaiHuLian
- Lianlian Pay
- SR online
- IcInfo
- LaoCaiBao
- NiuCard
- JieDaiBao
- JinHui365
- 91 Tech Group
- Lenovo
- Neoway
- Gizwits
- YY Cloud
- G7
- ShenzhenGuangliansaixun Co.，LTD.
- Guangzhou shang mai network technology co. LTD
- ultrapower
- DuiBa Group
- Cig
- Yeahmobi
- LeiMing
- ZhongChuang Technology
- DeepDraw
- WeiLaiXinFeng
- Guangzhou Zhongruan
- PubLink
================================================
FILE: docs/content/quick-start/_index.cn.md
================================================
+++
pre = "2. "
title = "快速入门"
weight = 2
chapter = true
+++
## 引入 Maven 依赖
```xml
使用方法: echo "dump@jobName" \| nc 127.0.0.1 9888 | ================================================ FILE: docs/content/user-manual/configuration/spring-namespace.en.md ================================================ +++ title = "Spring Namespace" weight = 2 chapter = true +++ To use the Spring namespace, user need to add the dependency of the `elasticjob-spring` module in the `pom.xml` file. ```xml
usage: echo "dump@jobName" \| nc 127.0.0.1 9888 | ================================================ FILE: docs/content/user-manual/operation/_index.cn.md ================================================ +++ pre = "4.1.3 " title = "运维手册" weight = 3 chapter = true +++ 本章节是 ElasticJob 的运维参考手册。 ================================================ FILE: docs/content/user-manual/operation/_index.en.md ================================================ +++ pre = "4.1.3 " title = "Operation" weight = 3 chapter = true +++ This chapter is an operation manual for ElasticJob. ================================================ FILE: docs/content/user-manual/operation/deploy-guide.cn.md ================================================ +++ title = "部署指南" weight = 1 chapter = true +++ ## 应用部署 1. 启动 ElasticJob 指定注册中心的 ZooKeeper。 1. 运行包含 ElasticJob 和业务代码的 jar 文件。不限于 jar 或 war 的启动方式。 1. 当作业服务器配置多网卡时，可通过设置系统变量 `elasticjob.preferred.network.interface` 指定网卡地址或 `elasticjob.preferred.network.ip` 指定IP。 ElasticJob 默认获取网卡列表中第一个非回环可用 IPV4 地址。 ## 运维平台和 RESTFul API 部署(可选) 1. 解压缩 `elasticjob-console-${version}.tar.gz` 并执行 `bin\start.sh`。 1. 打开浏览器访问 `http://localhost:8899/` 即可访问控制台。8899 为默认端口号，可通过启动脚本输入 `-p` 自定义端口号。 1. 访问 RESTFul API 方法同控制台。 1. `elasticjob-console-${version}.tar.gz` 可通过 `mvn install` 编译获取。 ================================================ FILE: docs/content/user-manual/operation/deploy-guide.en.md ================================================ +++ title = "Deploy Guide" weight = 1 chapter = true +++ ## Application deployment 1. Start the ZooKeeper of the ElasticJob designated registry. 1. Run the jar file containing ElasticJob and business code. It is not limited to the startup mode of jar or war. 1. When the job server is configured with multiple network cards, the network card address can be specified by setting the system variable `elasticjob.preferred.network.interface` or specify network addresses by setting the system variable `elasticjob.preferred.network.ip`. ElasticJob obtains the first non-loopback available IPV4 address in the network card list by default. ## Operation and maintenance platform and RESTFul API deployment (optional) 1. Unzip `elasticjob-console-${version}.tar.gz` and execute `bin\start.sh`. 1. Open the browser and visit `http://localhost:8899/` to access the console. 8899 is the default port number. You can customize the port number by entering `-p` through the startup script. 1. The method of accessing RESTFul API is the same as the console. 1. `elasticjob-console-${version}.tar.gz` can be obtained by compiling `mvn install`. ================================================ FILE: docs/content/user-manual/operation/dump.cn.md ================================================ +++ title = "导出作业信息" weight = 2 chapter = true +++ 使用 ElasticJob 过程中可能会碰到一些分布式问题，导致作业运行不稳定。 由于无法在生产环境调试，通过 dump 命令可以把作业内部相关信息导出，方便开发者调试分析； 另外为了不泄露隐私，已将相关信息中的 IP 地址以 ip1, ip2... 的形式过滤，可以在互联网上公开传输环境信息，便于进一步完善 ElasticJob。 ## 开启监听端口 使用 Java API 开启导出端口配置请参见[Java API 作业信息导出配置](/cn/user-manual/elasticjob/configuration/java-api)。 使用 Spring Boot Starter 开启导出端口配置请参见[Spring Boot Starter 作业信息导出配置](/cn/user-manual/elasticjob/configuration/java-api)。 使用 Spring 命名空间 开启导出端口配置请参见[Spring 命名空间 作业信息导出配置](/cn/user-manual/elasticjob/configuration/spring-namespace)。 ## 执行导出命令 导出命令完全参照 ZooKeeper 的四字命令理念。 **导出至标准输出** ```bash echo "dump@jobName" | nc <任意一台作业服务器IP> 9888 ```  **导出至文件** ```bash echo "dump@jobName" | nc <任意一台作业服务器IP> 9888 > job_debug.txt ``` ================================================ FILE: docs/content/user-manual/operation/dump.en.md ================================================ +++ title = "Dump Job Information" weight = 2 chapter = true +++ Using ElasticJob may meet some distributed problem which is not easy to observe. Because of developer cannot debug in production environment, ElasticJob provide `dump` command to export job runtime information for debugging. For security reason, the information dumped had already mask sensitive information, it instead of real IP address to `ip1`, `ip2` ... ## Open Listener Port To open listener port using Java, refer to [Java API job information export configuration](/en/user-manual/elasticjob/configuration/java-api). To open listener port using Spring Boot Starter, refer to [Spring Boot Starter job information export configuration](/en/user-manual/elasticjob/configuration/java-api). To open listener port using Spring Namespace, refer to [Spring namespace job information export configuration](/en/user-manual/elasticjob/configuration/spring-namespace). ## Execute Dump **Dump to stdout** ```bash echo "dump@jobName" | nc
================================================
FILE: docs/layouts/partials/menu-footer.html
================================================
================================================
FILE: docs/layouts/partials/style.html
================================================
================================================
FILE: docs/layouts/partials/toc.html
================================================
{{ if and (gt .WordCount 400 ) (.Params.toc) }}
{{ end }}
================================================
FILE: docs/layouts/shortcodes/bilibili.html
================================================
separator in menu */ } body { color: var(--MAIN-TEXT-color) !important; } textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { border-color: none; box-shadow: none; } h2, h3, h4, h5 { color: var(--MAIN-TITLES-TEXT-color) !important; } a { color: var(--MAIN-LINK-color); } .anchor { color: var(--MAIN-ANCHOR-color); } a:hover { color: var(--MAIN-LINK-HOVER-color); } #sidebar ul li.visited > a .read-icon { color: var(--MENU-VISITED-color); } #body a.highlight:after { display: block; content: ""; height: 1px; width: 0%; -webkit-transition: width 0.5s ease; -moz-transition: width 0.5s ease; -ms-transition: width 0.5s ease; transition: width 0.5s ease; background-color: var(--MAIN-LINK-HOVER-color); } #sidebar { background-color: var(--MENU-SECTIONS-BG-color); } #sidebar #header-wrapper { background: var(--MENU-HEADER-BG-color); color: var(--MENU-SEARCH-BOX-color); border-color: var(--MENU-HEADER-BORDER-color); } #sidebar .searchbox { border-color: var(--MENU-SEARCH-BOX-color); background: var(--MENU-SEARCH-BG-color); } #sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { background: var(--MENU-SECTIONS-ACTIVE-BG-color); } #sidebar .searchbox * { color: var(--MENU-SEARCH-BOX-ICONS-color); } #sidebar a { color: var(--MENU-SECTIONS-LINK-color); } #sidebar a:hover { color: var(--MENU-SECTIONS-LINK-HOVER-color); } #sidebar ul li.active > a { background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; } #sidebar hr { border-color: var(--MENU-SECTION-HR-color); } ``` Then, set the `themeVariant` value with the name of your custom theme file. That's it ! ```toml [params] # Change default color scheme with a variant one. Can be "red", "blue", "green". themeVariant = "mine" ``` ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.fr.md ================================================ --- date: 2016-04-09T16:50:16+02:00 title: Personnalisation du style weight: 25 --- **Hugo-theme-learn** a été conçu pour être aussi configurable que possible en définissant plusieurs [partials](https://gohugo.io/templates/partials/) Dans `themes/hugo-theme-learn/layouts/partials/`, vous pourrez trouver tous les *partials* définis pour ce thème. Si vous avez besoin d'écraser quelque chose, ne modifiez pas le code directement. A la place, [suivez cette page](https://gohugo.io/themes/customizing/). Vous créerez alors un nouveau *partial* dans le dossier `layouts/partials` de votre site local. Ce *partial* aura la priorité. Ce thème définit les *partials* suivant : - *header*: l'en-tête de la page page (contient le fil d'Ariane). _Pas voué à être écrasé_ - *custom-header*: En-tête personnalisé. Voué à être écrasé quand vous ajoutez des imports CSS. N'oubliez pas d'inclure la balise HTML `style` dans votre fichier - *footer*: le pied-de-page de la page (contains les flèches). _Pas voué à être écrasé_ - *custom-footer*: Pied-de-page personnalisé. Voué à être écrasé quand vous ajoutez du Javascript. N'oubliez pas d'inclure la balise HTML `javascript` dans votre fichier - *favicon*: le favicon - *logo*: le logo, affiché un haut à gauche. - *meta*: les balises HTML meta, que vous pouvez écraser sans problème. - *menu*: Le menu à gauche. _Pas voué à être écrasé_ - *menu-footer*: Le pied-de-page du menu - *search*: le champ de recherche - *toc*: le sommaire ## Changer le logo Créez un nouveau fichier dans `layouts/partials/`, nommé `logo.html`. Puis, écrivez le code HTML voulu. Vous pourriez utiliser une balise HTML `img` et référencer une image créée dans le dossier *static*, voire même y coller un cod SVG ! {{% notice note %}} La taille du logo va s'adapter automatiquement {{% /notice %}} ## Changer le favicon Si votre favicon est un png, déposez votre image dans votre dossier local `static/images/` et nommez le `favicon.png` Si vous avez besoin de changer ce comportement par défaut, créer un nouveau fichier dans `layouts/partials/` et nommez le `favicon.html`. Puis ajoutez quelque chose comme: ```html ``` ## Changer les couleurs par défaut {#theme-variant} **Hugo Learn theme** vous permet de choisir nativement entre 3 schéma de couleurs, mais n'hésitez pas à en ajouter d'autres ! Les couleurs par défaut sont celles de [Grav Learn Theme](https://learn.getgrav.org/). ### Variante rouge ```toml [params] # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". themeVariant = "red" ```  ### Variante bleue ```toml [params] # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". themeVariant = "blue" ```  ### Variante verte ```toml [params] # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". themeVariant = "green" ```  ### Votre variante Premièrement, créez un nouveau fichier CSS dans votre dossier `static/css`, préfixé par `theme` (ex: avec le theme_lemien_ `static/css/theme-lemien.css`). Copiez le contenu suivant et modifiez les couleurs dans les variables CSS. ```css :root{ --MAIN-TEXT-color:#323232; /* Color of text by default */ --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ --MAIN-LINK-color:#1C90F3; /* Color of links */ --MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */ --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ --MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */ --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */ --MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */ --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */ --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */ --MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */ --MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */ --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ --MENU-SECTION-HR-color: #20272b; /* Color of
separator in menu */ } body { color: var(--MAIN-TEXT-color) !important; } textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { border-color: none; box-shadow: none; } h2, h3, h4, h5 { color: var(--MAIN-TITLES-TEXT-color) !important; } a { color: var(--MAIN-LINK-color); } .anchor { color: var(--MAIN-ANCHOR-color); } a:hover { color: var(--MAIN-LINK-HOVER-color); } #sidebar ul li.visited > a .read-icon { color: var(--MENU-VISITED-color); } #body a.highlight:after { display: block; content: ""; height: 1px; width: 0%; -webkit-transition: width 0.5s ease; -moz-transition: width 0.5s ease; -ms-transition: width 0.5s ease; transition: width 0.5s ease; background-color: var(--MAIN-LINK-HOVER-color); } #sidebar { background-color: var(--MENU-SECTIONS-BG-color); } #sidebar #header-wrapper { background: var(--MENU-HEADER-BG-color); color: var(--MENU-SEARCH-BOX-color); border-color: var(--MENU-HEADER-BORDER-color); } #sidebar .searchbox { border-color: var(--MENU-SEARCH-BOX-color); background: var(--MENU-SEARCH-BG-color); } #sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { background: var(--MENU-SECTIONS-ACTIVE-BG-color); } #sidebar .searchbox * { color: var(--MENU-SEARCH-BOX-ICONS-color); } #sidebar a { color: var(--MENU-SECTIONS-LINK-color); } #sidebar a:hover { color: var(--MENU-SECTIONS-LINK-HOVER-color); } #sidebar ul li.active > a { background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; } #sidebar hr { border-color: var(--MENU-SECTION-HR-color); } ``` Puis, configurez le paramètre `themeVariant` avec le nom de votre variante. C'est tout ! ```toml [params] # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". themeVariant = "lemien" ``` ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/cont/_index.en.md ================================================ --- title: Content weight: 10 chapter: true pre: "2. " --- ### Chapter 2 # Content Find out how to create and organize your content quickly and intuitively. ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/cont/_index.fr.md ================================================ --- title: Contenu weight: 10 chapter: true pre: "2. " --- ### Chapitre 2 # Contenu Découvrez comment créer et organiser votre contenu facilement et intuitivement. ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.en.md ================================================ --- title: Archetypes weight: 10 --- Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more : [archetypes](https://gohugo.io/content/archetypes/). It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences. ## Chapter {#archetypes-chapter} To create a Chapter page, run the following commands ``` hugo new --kind chapter
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
``` ## Comments Comments should be HTML compatible ```html ``` Comment below should **NOT** be seen: ## Horizontal Rules The HTML `` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `
` with any of the following: * `___`: three consecutive underscores * `---`: three consecutive dashes * `***`: three consecutive asterisks renders to: ___ --- *** ## Body Copy Body copy written as normal, plain text will be wrapped with `` tags in the rendered HTML. So this body copy: ```markdown Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. ``` renders to this HTML: ```html
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
``` ## Emphasis ### Bold For emphasizing a snippet of text with a heavier font-weight. The following snippet of text is **rendered as bold text**. ```markdown **rendered as bold text** ``` renders to: **rendered as bold text** and this HTML ```html rendered as bold text ``` ### Italics For emphasizing a snippet of text with italics. The following snippet of text is _rendered as italicized text_. ```markdown _rendered as italicized text_ ``` renders to: _rendered as italicized text_ and this HTML: ```html rendered as italicized text ``` ### strikethrough In GFM (GitHub flavored Markdown) you can do strikethroughs. ```markdown ~~Strike through this text.~~ ``` Which renders to: ~~Strike through this text.~~ HTML: ```html``` Blockquotes can also be nested: ```markdown > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. >> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. ``` Renders to: > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. >> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. ## Notices {{% notice note %}} The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) {{% /notice %}} ## Lists ### Unordered A list of items in which the order of the items does not explicitly matter. You may use any of the following symbols to denote bullets for each list item: ```markdown * valid bullet - valid bullet + valid bullet ``` For example ```markdown + Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem ``` Renders to: + Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem And this HTML ```htmlFusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
In this example, <section></section> should be wrapped with code.
// Some comments line 1 of code line 2 of code line 3 of codeRenders to: // Some comments line 1 of code line 2 of code line 3 of code HTML: ```html
// Some comments
line 1 of code
line 2 of code
line 3 of code
```
### Block code "fences"
Use "fences" ```` ``` ```` to block in multiple lines of code.
``` markup Sample text here... `````` Sample text here... ``` HTML: ```html
Sample text here...
```
### Syntax highlighting
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
```js
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
Renders to:
```js
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
## Tables
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
```markdown
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
```
Renders to:
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
And this HTML:
```html
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
``` ## Comments Comments should be HTML compatible ```html ``` Comment below should **NOT** be seen: ## Horizontal Rules The HTML `` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `
` with any of the following: * `___`: three consecutive underscores * `---`: three consecutive dashes * `***`: three consecutive asterisks renders to: ___ --- *** ## Body Copy Body copy written as normal, plain text will be wrapped with `` tags in the rendered HTML. So this body copy: ```markdown Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. ``` renders to this HTML: ```html
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
``` ## Emphasis ### Bold For emphasizing a snippet of text with a heavier font-weight. The following snippet of text is **rendered as bold text**. ```markdown **rendered as bold text** ``` renders to: **rendered as bold text** and this HTML ```html rendered as bold text ``` ### Italics For emphasizing a snippet of text with italics. The following snippet of text is _rendered as italicized text_. ```markdown _rendered as italicized text_ ``` renders to: _rendered as italicized text_ and this HTML: ```html rendered as italicized text ``` ### strikethrough In GFM (GitHub flavored Markdown) you can do strikethroughs. ```markdown ~~Strike through this text.~~ ``` Which renders to: ~~Strike through this text.~~ HTML: ```html``` Blockquotes can also be nested: ```markdown > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. >> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. ``` Renders to: > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. >> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. ## Notices {{% notice note %}} The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) {{% /notice %}} ## Lists ### Unordered A list of items in which the order of the items does not explicitly matter. You may use any of the following symbols to denote bullets for each list item: ```markdown * valid bullet - valid bullet + valid bullet ``` For example ```markdown + Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem ``` Renders to: + Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem And this HTML ```htmlFusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
In this example, <section></section> should be wrapped with code.
// Some comments line 1 of code line 2 of code line 3 of codeRenders to: // Some comments line 1 of code line 2 of code line 3 of code HTML: ```html
// Some comments
line 1 of code
line 2 of code
line 3 of code
```
### Block code "fences"
Use "fences" ```` ``` ```` to block in multiple lines of code.
``` markup Sample text here... `````` Sample text here... ``` HTML: ```html
Sample text here...
```
### Syntax highlighting
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
```js
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
Renders to:
```js
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
## Tables
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
```markdown
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
```
Renders to:
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
And this HTML:
```html
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
The **pattern** parameter value must be [regular expressions](https://en.wikipedia.org/wiki/Regular_expression). For example: * To match a file suffix of 'jpg', use **.*jpg** (not *.jpg). * To match file names ending in 'jpg' or 'png', use **.*(jpg|png)** ### Examples #### List of attachments ending in pdf or mp4 {{%/*attachments title="Related files" pattern=".*(pdf|mp4)"/*/%}} renders as {{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}} #### Colored styled box {{%/*attachments style="orange" /*/%}} renders as {{% attachments style="orange" /%}} {{%/*attachments style="grey" /*/%}} renders as {{% attachments style="grey" /%}} {{%/*attachments style="blue" /*/%}} renders as {{% attachments style="blue" /%}} {{%/*attachments style="green" /*/%}} renders as {{% attachments style="green" /%}} ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.md ================================================ --- title: Attachments (Pièces jointes) description : "The Attachments shortcode displays a list of files attached to a page." --- Le shortcode *Attachments* affiche une liste de pièces jointes d'une page. {{% attachments /%}} ## Utilisation Le shortcode affiche la liste de fichiers trouvés dans un **dossier spécifique** A l'heure actuelle, il supporte deux implémentations 1. Si votre page est un fichier Markdown, les pièces jointes doivent être placée dans un **dossier** nommé comme le nom de la page et suffixé par **.files**. > * content > * _index.md > * page.files > * attachment.pdf > * page.md 2. Si votre page est un **dossier**, les pièces jointes doivent être placées dans un dossier fils **'files'**. > * content > * _index.md > * page > * index.md > * files > * attachment.pdf Attention, si votre site est multi-langue, vous devrez avec autant de dossier qu'il y a de langues. C'est tout ! ### Paramètres | Paramètre | Défaut | Description | |:--|:--|:--| | title | "Pièces jointes" | Titre de la liste | | style | "" | Choisir entre "orange", "grey", "blue" et "green" pour un style plus sympa | | pattern | ".*" | Une expression régulière, utilisée pour filtrer les pièces jointes par leur nom de fichier.
Le paramètre **pattern** doit être une [expression régulière](https://en.wikipedia.org/wiki/Regular_expression). Par exemple: * Pour trouver les fichiers avec le suffixe 'jpg', utilisez **.*jpg** (pas *.jpg). * Pour trouver les fichiers avec les suffixe 'jpg' ou 'png', utilisez **.*(jpg|png)** ### Exemples #### Lister les pièces jointes de type pdf ou mp4 {{%/*attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/*/%}} s'affiche comme {{%attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/%}} #### Modifier le style {{%/*attachments style="orange" /*/%}} s'affiche comme {{% attachments style="orange" /%}} {{%/*attachments style="grey" /*/%}} s'affiche comme {{% attachments style="grey" /%}} {{%/*attachments style="blue" /*/%}} s'affiche comme {{% attachments style="blue" /%}} {{%/*attachments style="green" /*/%}} s'affiche comme {{% attachments style="green" /%}} ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.en.md ================================================ --- title: Button description : "Nice buttons on your page." --- A button is a just a clickable button with optional icon. ``` {{%/* button href="https://getgrav.org/" */%}}Get Grav{{%/* /button */%}} {{%/* button href="https://getgrav.org/" icon="fa fa-download" */%}}Get Grav with icon{{%/* /button */%}} {{%/* button href="https://getgrav.org/" icon="fa fa-download" icon-position="right" */%}}Get Grav with icon right{{%/* /button */%}} ``` {{% button href="https://getgrav.org/" %}}Get Grav{{% /button %}} {{% button href="https://getgrav.org/" icon="fa fa-download" %}}Get Grav with icon{{% /button %}} {{% button href="https://getgrav.org/" icon="fa fa-download" icon-position="right" %}}Get Grav with icon right{{% /button %}} ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.fr.md ================================================ --- title: Button (Bouton) description : "De beaux boutons sur votre page." --- Le shortcode *button* est simplement un bouton cliquable avec une icône optionnelle. ``` {{%/* button href="https://getgrav.org/" */%}}Téléchargez Grav{{%/* /button */%}} {{%/* button href="https://getgrav.org/" icon="fa fa-download" */%}}Téléchargez Grav avec icône{{%/* /button */%}} {{%/* button href="https://getgrav.org/" icon="fa fa-download" icon-position="right" */%}}Téléchargez Grav avec icône à droite{{%/* /button */%}} ``` {{% button href="https://getgrav.org/" %}}Téléchargez Grav{{% /button %}} {{% button href="https://getgrav.org/" icon="fa fa-download" %}}Téléchargez Grav avec icône{{% /button %}} {{% button href="https://getgrav.org/" icon="fa fa-download" icon-position="right" %}}Téléchargez Grav avec icône à droite{{% /button %}} ================================================ FILE: docs/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md ================================================ --- title : Children description : List the child pages of a page --- Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages. ## Usage | Parameter | Default | Description | |:--|:--|:--| | page | _current_ | Specify the page name (section name) to display children for | | style | "li" | Choose the style used to display descendants. It could be any HTML tag name | | showhidden | "false" | When true, child pages hidden from the menu will be displayed | | description | "false" | Allows you to include a short text under each page in the list.
when no description exists for the page, children shortcode takes the first 70 words of your content. [read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/) | | depth | 1 | Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages.
**Tips:** set 999 to get all descendants| | sort | none | Sort Children By
quand aucune description existe pour la page, le shortcode prend les 70 premiers mots du contenu. [plus d'infos sur gohugo.io](https://gohugo.io/content/summaries/) | | depth | 1 | Nombre de descendants à afficher. Par exemple, si la valeur est 2, le shortcode va afficher 2 niveaux de pages filels.
**Astuce:** Utilisez 999 pour avoir tous les descendants| | sort |
prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! {{}} renders as {{
prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! {{< /mermaid >}} ## GANTT Example {{}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to mermaid :1d {{}} render as {{
prédominent... John-->Alice: Super! John->Bob: Et toi? Bob-->John: Au top! {{}} renders as {{
prédominent... John-->Alice: Super! John->Bob: Et toi? Bob-->John: Au top! {{< /mermaid >}} ## GANTT Example {{}} gantt dateFormat YYYY-MM-DD title Ajout de la fonctionnalité de GANTT à Mermaid section Une section Tâche complétée :done, des1, 2014-01-06,2014-01-08 Tâche en cours :active, des2, 2014-01-09, 3d Future tâche : des3, after des2, 5d Future tâche 2 : des4, after des3, 5d section Tâches critiques Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h Implémenter le parser et jison :crit, done, after des1, 2d Créer des tests pour le parser :crit, active, 3d Future tâche dans le chemin critique :crit, 5d Créer des tests pour le renderer :2d Ajout à Mermaid :1d {{}} render as {{
{{ $url := .Get 0 }}
{{ range getJSON $url }}
{{.contributions}} commits
{{ end }}
================================================
FILE: docs/themes/hugo-theme-learn/exampleSite/static/css/theme-mine.css
================================================
:root{
--MAIN-TEXT-color:#323232; /* Color of text by default */
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
--MAIN-LINK-color:#599a3e; /* Color of links */
--MAIN-LINK-HOVER-color:#3f6d2c; /* Color of hovered links */
--MAIN-ANCHOR-color: #599a3e; /* color of anchors on titles */
--MENU-HEADER-BG-color:#74b559; /* Background color of menu header */
--MENU-HEADER-BORDER-color:#9cd484; /*Color of menu header border */
--MENU-SEARCH-BG-color:#599a3e; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BOX-color: #84c767; /* Override search field border color */
--MENU-SEARCH-BOX-ICONS-color: #c7f7c4; /* Override search field icons color */
--MENU-SECTIONS-ACTIVE-BG-color:#1b211c; /* Background color of the active section and its childs */
--MENU-SECTIONS-BG-color:#222723; /* Background color of other sections */
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
--MENU-VISITED-color: #599a3e; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #18211c; /* Color of separator in menu */ } body { color: var(--MAIN-TEXT-color) !important; } textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { border-color: none; box-shadow: none; } h2, h3, h4, h5 { color: var(--MAIN-TITLES-TEXT-color) !important; } a { color: var(--MAIN-LINK-color); } .anchor { color: var(--MAIN-ANCHOR-color); } a:hover { color: var(--MAIN-LINK-HOVER-color); } #sidebar ul li.visited > a .read-icon { color: var(--MENU-VISITED-color); } #body a.highlight:after { display: block; content: ""; height: 1px; width: 0%; -webkit-transition: width 0.5s ease; -moz-transition: width 0.5s ease; -ms-transition: width 0.5s ease; transition: width 0.5s ease; background-color: var(--MAIN-LINK-HOVER-color); } #sidebar { background-color: var(--MENU-SECTIONS-BG-color); } #sidebar #header-wrapper { background: var(--MENU-HEADER-BG-color); color: var(--MENU-SEARCH-BOX-color); border-color: var(--MENU-HEADER-BORDER-color); } #sidebar .searchbox { border-color: var(--MENU-SEARCH-BOX-color); background: var(--MENU-SEARCH-BG-color); } #sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { background: var(--MENU-SECTIONS-ACTIVE-BG-color); } #sidebar .searchbox * { color: var(--MENU-SEARCH-BOX-ICONS-color); } #sidebar a { color: var(--MENU-SECTIONS-LINK-color); } #sidebar a:hover { color: var(--MENU-SECTIONS-LINK-HOVER-color); } #sidebar ul li.active > a { background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; } #sidebar hr { border-color: var(--MENU-SECTION-HR-color); } ================================================ FILE: docs/themes/hugo-theme-learn/i18n/en.toml ================================================ [Search-placeholder] other = "Search..." [Clear-History] other = "Clear History" [Attachments-label] other = "Attachments" [title-404] other = "Error" [message-404] other = "Woops. Looks like this page doesn't exist ¯\\_(ツ)_/¯." [Go-to-homepage] other = "Go to homepage" [Edit-this-page] other = "Edit this page" [Shortcuts-Title] other = "More" [Expand-title] other = "Expand me..." ================================================ FILE: docs/themes/hugo-theme-learn/i18n/es.toml ================================================ [Search-placeholder] other = "Buscar..." [Clear-History] other = "Borrar Historial" [Attachments-label] other = "Adjuntos" [title-404] other = "Error" [message-404] other = "Ups. Parece que la página no existe ¯\\_(ツ)_/¯." [Go-to-homepage] other = "Ir al inicio" [Edit-this-page] other = "Editar esta página" [Shortcuts-Title] other = "Más" [Expand-title] other = "Expandir..." ================================================ FILE: docs/themes/hugo-theme-learn/i18n/fr.toml ================================================ [Search-placeholder] other = "Rechercher..." [Clear-History] other = "Supprimer l'historique" [Attachments-label] other = "Pièces jointes" [title-404] other = "Erreur" [message-404] other = "Oups. On dirait que cette page n'existe pas ¯\\_(ツ)_/¯" [Go-to-homepage] other = "Vers la page d'accueil" [Edit-this-page] other = "Modifier la page" [Shortcuts-Title] other = "Aller plus loin" [Expand-title] other = "Déroulez-moi..." ================================================ FILE: docs/themes/hugo-theme-learn/i18n/pt.toml ================================================ [Search-placeholder] other = "Procurar..." [Clear-History] other = "Limpar Histórico" [Attachments-label] other = "Anexos" [title-404] other = "Erro" [message-404] other = "Ops. Parece que a página não existe ¯\\_(ツ)_/¯." [Go-to-homepage] other = "Ir para o início" [Edit-this-page] other = "Editar esta página" [Shortcuts-Title] other = "Mais" [Expand-title] other = "Expandir..." ================================================ FILE: docs/themes/hugo-theme-learn/layouts/404.html ================================================ {{ partial "meta.html" . }} {{ partial "favicon.html" . }} {{ .Scratch.Add "title" "" }}{{ if eq .Site.Data.titles .Title }}{{ .Scratch.Set "title" (index .Site.Data.titles .Title).title }}{{ else }}{{ .Scratch.Set "title" .Title}}{{end}}
![]({{ "/images/gopher-404.jpg" | relURL }})
Personaliser la page d'accueil
Le site fonctionne. Ne pas oublier de personaliser cette page avec votre propre contenu. 3 manières de faire :
- 1. Créer un fichier _index.md dans le dossier content et le remplir de Markdown
- 2. Créer un fichier index.html dans le dossier static et le remplir de code HTML
- 3. Configurer le serveur http pour rediriger automatiquement la homepage vers la page de votre choix dans le site
Customize your own home page
The site is working. Don't forget to customize this homepage with your own. You typically have 3 choices :
- 1. Create an _index.md document in content folder and fill it with Markdown content
- 2. Create an index.html file in the static folder and fill the file with HTML content
- 3. Configure your server to automatically redirect home page to one your documentation page
{{ if eq .Lang "en"}}
Retro
Eye care
Haitian
Deep
Dark
Default
{{ else }}
复古
护眼
海天
深邃
暗黑
默认
{{ end }}